Sign in

v3

latestOpenAPI 3.0.12026-08-0678153248.4 KB

Start a browser use task

post/api/task/browser-use

Request body

taskstring required
version'0.1.40' | '0.7.10' | 'latest'
llm'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'claude-sonnet-5' | 'claude-sonnet-4-6' | 'claude-sonnet-4-5' | 'claude-sonnet-4-20250514' | 'gemini-2.0-flash' | 'gemini-2.5-flash'
sessionIdstring
validateOutputboolean
useVisionboolean
useVisionForPlannerboolean
maxActionsPerStepnumber
maxInputTokensnumber
plannerLlm'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'claude-sonnet-5' | 'claude-sonnet-4-6' | 'claude-sonnet-4-5' | 'claude-sonnet-4-20250514' | 'gemini-2.0-flash' | 'gemini-2.5-flash'
pageExtractionLlm'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'claude-sonnet-5' | 'claude-sonnet-4-6' | 'claude-sonnet-4-5' | 'claude-sonnet-4-20250514' | 'gemini-2.0-flash' | 'gemini-2.5-flash'
plannerIntervalnumber
maxStepsnumber
maxFailuresnumber
initialActionsobject[]
sensitiveDataobject
messageContextstring
keepBrowserOpenboolean
useCustomApiKeysboolean

Example request

{
  "sessionOptions": {
    "proxyCity": "new york"
  }
}

Response

Browser use task started successfully

jobIdstring required
liveUrlstring nullable