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:gpt-5.6-luna
Available options:
glm-5.2,
grok-4.5,
kimi-k3,
minimax-m3,
claude-opus-4.7,
claude-opus-4.8,
claude-opus-5,
claude-fable-5,
claude-sonnet-5,
gpt-5.5,
gpt-5.6,
gpt-5.6-sol,
gpt-5.6-terra,
gpt-5.6-luna,
gemini-3.6-flash,
gemini-3.5-flash,
gemini-3.1-pro,
gemini-3-flash
modelParams
Modelparams · object | null

Optional provider-native request parameters for the selected model, written with the provider's own field names and values and forwarded unchanged (e.g. {"reasoning": {"effort": "high"}} for OpenAI, {"thinking": {"type": "adaptive"}} for Anthropic, {"thinkingConfig": {"thinkingLevel": "high"}} for Google). Supported paths and values are per-model; an unsupported path, value, or a model that accepts no parameters at all is rejected with 422. Omitting this field applies the model's default parameters (gpt-5.6-luna defaults to {"reasoning": {"effort": "xhigh"}}); passing {} opts out of that default and leaves the provider's own defaults in place.

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.

agentmail
boolean
default:false

If true, provisions a persistent temporary email inbox (via AgentMail) for the run workspace. The agent receives the email address in its context and can send, receive, read, and reply to email. Set false to disable AgentMail for this run.

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

Credentials this run may use without ever seeing them. The agent can ask the server to type a binding by alias on one of its allowed domains; it cannot read the value. Bindings are not persisted past the run.

Maximum array length: 10
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>[]