Skip to main content
POST
Create Run

Authorizations

X-Browser-Use-API-Key
string
header
required

Body

application/json
task
string
required
Minimum string length: 1
model
enum<string>
default:minimax-m3
Available options:
glm-5.2,
grok-4.5,
minimax-m3,
claude-opus-4.7,
claude-opus-4.8,
claude-sonnet-5,
gpt-5.5,
gpt-5.6,
gemini-3.5-flash,
gemini-3.1-pro,
gemini-3-flash
sessionId
string<uuid> | null
workspaceId
string<uuid> | null
browserSettings
RunBrowserSettings · object | null

Browser config, owned by the browser row (never the run). Follow-ups: omitted fields inherit the session's prior browser; explicit values apply only to newly provisioned browsers (a live browser is reused as-is). Profile is the exception: a different profile → 400; an explicit value mismatching the live browser's profile (incl. null vs a profiled browser) declines reuse and provisions fresh. A live browser already matching the requested profile is reused.

attachedFileIds
string<uuid>[] | null
Maximum array length: 20
judge
RunJudgeSettings · object | null

Opt-in LLM judgement of the finished run. Presence of this object turns the judge on (send {} for defaults); CP judges the run's trajectory after it goes terminal and surfaces the verdict as RunSummary.judgement (null until it lands). The judge's LLM call is billed to the run.

maxCostUsd
Required range: x > 0

Response

Successful Response

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
dispatching,
running,
completed,
failed,
cancelled
model
string
required
sessionId
string<uuid>
required
workspaceId
string<uuid>
required
eventsUrl
string
required
missingFileIds
string<uuid>[]