Skip to content
warren

POST /runs

POST
/runs
curl --request POST \
  --url https://example.com/runs

Responses

Section titled “Responses”

200

Section titled “200”

Successful response.

Media typeapplication/json
object
run
required
object
id
required
string
agentName
required
string
projectId
string | null
sandboxId
string | null
sandboxRunId
string | null
seedId
string | null
parentRunId
string | null
cloneKind
string | null
Allowed values: replicate continue
mode
required
string
Allowed values: batch
provider
string | null
model
string | null
renderedAgentJson
state
required
string
Allowed values: queued running succeeded failed cancelled
failureReason
string | null
Allowed values: never_started no_model_response sandbox_failed spawn_failed crashed agent_died timed_out sandbox_run_lost sandbox_unreachable dropped_commit no_changes finalize_failed push_rejected_policy finalize_unposted provider_error oom_killed evicted
createdAt
number | null
startedAt
string | null
endedAt
string | null
commitsAhead
integer | null
filesChanged
integer | null
insertions
integer | null
deletions
integer | null
prompt
required
string
trigger
required
string
prUrl
string | null
prState
string | null
Allowed values: open merged closed_unmerged
prMergedAt
string | null
targetBranch
string | null
ref
string | null
salvageRef
string | null
salvagePath
string | null
costUsd
number | null
tokensInput
integer | null
tokensOutput
integer | null
tokensCacheRead
integer | null
tokensCacheWrite
integer | null
previewState
string | null
Allowed values: starting live failed torn-down
previewPort
integer | null
previewStartedAt
string | null
previewLastHitAt
string | null
previewFailureMessage
string | null
costBasis
required
string
Allowed values: api subscription_estimate
sandbox
required
object
id
required
string
workspacePath
required
string
Example
{
  "run": {
    "cloneKind": "replicate",
    "mode": "batch",
    "state": "queued",
    "failureReason": "never_started",
    "prState": "open",
    "previewState": "starting",
    "costBasis": "api"
  }
}

default

Section titled “default”

Error response (see src/core/errors.ts).

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
hint
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "hint": "example"
  }
}