Warp agent API is one of 5 APIs that Warp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 3 JSON Schema definitions.
Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.
This API exposes
20 operations
across 16 paths,
and defines 79 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://app.warp.dev/api/v1.
The identity and technical contract details declared by the specification.
RunStatusMessage
object
Status message for a run. For terminal error states, includes structured error code and retryability info from the platform error catalog.
3 properties
1 required
ActionCategory
string
High-level category of an action performed during the conversation
CreateAgentRequest
object
11 properties
1 required
CloudEnvironmentConfig
object
Configuration for a cloud environment used by scheduled agents
6 properties
MCPServerConfig
object
Configuration for an MCP server. Must have exactly one of: warpid, command, or url.
6 properties
ConnectedSelfHostedWorker
object
4 properties
4 required
AgentSkill
object
Information about the agent skill used for the run. Either fullpath or bundledskillid will be set, but not both.
4 properties
ConversationStep
object
7 properties
3 required
CloudEnvironment
object
A cloud environment for running agents
9 properties
4 required
PlanArtifactResponseData
object
Response data for a plan artifact, including current markdown content.
6 properties
4 required
EnvironmentLastTask
object
Summary of the most recently created task for an environment
6 properties
5 required
PageInfo
object
2 properties
1 required
ScreenshotArtifactResponse
object
Response for retrieving a screenshot artifact.
4 properties
4 required
ConversationMessage
object
5 properties
2 required
Harness
object
Specifies which execution harness to use for the agent run. Default (nil/empty) uses Warp's built-in harness.
1 property
ModelInfo
object
7 properties
4 required
ListConnectedSelfHostedWorkersResponse
object
1 property
1 required
GcpProviderConfig
object
GCP Workload Identity Federation settings
4 properties
3 required
AgentListItem
object
2 properties
2 required
ScreenshotArtifactResponseData
object
Response data for a screenshot artifact, including a signed download URL.
4 properties
3 required
RunAgentResponse
object
4 properties
3 required
AgentRunMode
string
Query mode for an agent run. - normal: Standard user query (default). - plan: Planning Mode. The agent researches and creates a plan, then waits for approval b…
ActionContentBlock
object
6 properties
5 required
ListModelsResponse
object
2 properties
2 required
PullRequestArtifactData
object
2 properties
2 required
HarnessAuthSecrets
object
Authentication secrets for third-party harnesses. Only the secret for the harness specified gets injected into the environment.
2 properties
PlanArtifact
object
3 properties
3 required
AwsProviderConfig
object
AWS IAM role assumption settings
1 property
1 required
AgentListSource
object
4 properties
3 required
AgentListEnvironment
object
2 properties
2 required
RunItem
object
26 properties
7 required
RunExecutionLocation
string
Where the run executed: - LOCAL: Executed in the user's local Oz environment - REMOTE: Executed by a remote/cloud worker
AmbientAgentConfig
object
Configuration for a cloud agent run
15 properties
AgentListVariant
object
7 properties
5 required
SecretRef
object
Reference to a managed secret by name.
1 property
1 required
SessionSharingConfig
object
Configures sharing behavior for the run's shared session. When set, the worker emits --share public: and the bundled Warp client applies an anyone-with-link AC…
1 property
RunCreatorInfo
object
5 properties
ListAgentIdentitiesResponse
object
1 property
1 required
FileArtifactData
object
6 properties
4 required
GitHubRepo
object
2 properties
2 required
ScreenshotArtifact
object
3 properties
3 required
AgentResponse
object
15 properties
8 required
Scope
object
Ownership scope for a resource (team or personal)
2 properties
1 required
ScheduleInfo
object
Information about the schedule that triggered this run (only present for scheduled runs)
3 properties
3 required
ConversationMessageRole
string
Role of the normalized message
RunFollowupRequest
object
Request body for submitting a follow-up message to an existing run.
2 properties
ListRunsResponse
object
2 properties
2 required
PlatformErrorCode
string
Machine-readable error code identifying the problem type. Used in the type URI of Error responses and in the errorcode field of RunStatusMessage. User errors (…
AIRunTimelineEvent
object
A setup or lifecycle event recorded for an agent run.
6 properties
4 required
GetRunTimelineResponse
object
Response body for listing run timeline events.
1 property
1 required
AttachmentInput
object
A base64-encoded file attachment to include with the prompt
3 properties
3 required
FileArtifactResponseData
object
Response data for a file artifact, including a signed download URL.
7 properties
5 required
PlanArtifactData
object
5 properties
1 required
ActionResultContentBlock
object
7 properties
6 required
RunState
string
Current state of the run: - QUEUED: Run is waiting to be picked up - PENDING: Run is being prepared - CLAIMED: Run has been claimed by a worker - INPROGRESS: R…
AwsInferenceProviderConfig
object
Configures AWS Bedrock as the LLM inference provider for this agent or run.
3 properties
ProvidersConfig
object
Optional cloud provider configurations for automatic auth
2 properties
ActionState
string
State of an action result
PlanArtifactResponse
object
Response for retrieving a plan artifact.
4 properties
4 required
UpdateAgentRequest
object
Partial update for an agent. Each field is optional: Omitted or null: leave the field unchanged. Empty value: clear the field. Non-empty: replace the field who…
11 properties
Error
object
Error response following RFC 7807 (Problem Details for HTTP APIs). Includes backward-compatible extension members. The response uses the application/problem+js…
8 properties
4 required
TextContentBlock
object
3 properties
2 required
RunAgentRequest
object
Request body for creating a new agent run. Either prompt or skill (via skill field, config.skillspec, or config.skills) is required, except for handoff request…
11 properties
InferenceProvidersConfig
object
Inference provider settings used for LLM calls.
1 property
FileArtifactResponse
object
Response for retrieving a file artifact.
4 properties
4 required
ScreenshotArtifactData
object
3 properties
2 required
AIRunTimelineEventType
string
Type of timeline event recorded for a run.
ConversationResponse
object
2 properties
2 required
PullRequestArtifact
object
3 properties
3 required
RequestUsage
object
Resource usage information for the run
3 properties
MemoryStoreRef
object
Reference to a memory store to attach to an agent.
3 properties
3 required
RunSourceType
string
Source that created the run: - LINEAR: Created from Linear integration - API: Created via the Warp API - SLACK: Created from Slack integration - LOCAL: Created…
FileArtifact
object
3 properties
3 required
ListEnvironmentsResponse
object
1 property
1 required
EventContentBlock
object
4 properties
3 required
ListAgentsResponse
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Warp publishes across the network.
