HYhyperbrowser

Start a browser use task

Changed on
post/api/task/browser-use

Request

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-haiku-5-5' | 'gemini-2.0-flash' | 'gemini-2.5-flash' | 'gemini-3.8-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-haiku-5-5' | 'gemini-2.0-flash' | 'gemini-2.5-flash' | 'gemini-3.8-flash'
pageExtractionLlm'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'claude-sonnet-5' | 'claude-sonnet-4-6' | 'claude-haiku-5-5' | 'gemini-2.0-flash' | 'gemini-2.5-flash' | 'gemini-3.8-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

Changes

  • 1e61734dcedbRevision changes
    • info

      the request property default value changed from 0.1.40 to 0.7.10

  • 466402067034Revision changes
    • breaking

      removed the enum value claude-sonnet-4-20250514 of the request property

    • breaking

      removed the enum value claude-sonnet-4-20250514 of the request property

    • breaking

      removed the enum value claude-sonnet-4-20250514 of the request property

    • breaking

      removed the enum value claude-sonnet-4-5 of the request property

    • breaking

      removed the enum value claude-sonnet-4-5 of the request property

    • breaking

      removed the enum value claude-sonnet-4-5 of the request property