LogoLogo
SupportDashboard
  • Community
  • Welcome to Hyperbrowser
  • Get Started
    • Quickstart
      • AI Agents
        • Browser Use
        • Claude Computer Use
        • OpenAI CUA
      • Web Scraping
        • Scrape
        • Crawl
        • Extract
      • Browser Automation
        • Puppeteer
        • Playwright
        • Selenium
  • Agents
    • Browser Use
    • Claude Computer Use
    • OpenAI CUA
  • HyperAgent
    • About HyperAgent
      • HyperAgent SDK
      • HyperAgent Types
  • Quickstart
  • Multi-Page actions
  • Custom Actions
  • MCP Support
    • Tutorial
  • Examples
    • Custom Actions
    • LLM support
    • Cloud Support
      • Setting Up
      • Proxies
      • Profiles
    • MCP Examples
      • Google Sheets
      • Weather
        • Weather Server
    • Output to Schema
  • Web Scraping
    • Scrape
    • Crawl
    • Extract
  • Sessions
    • Overview
      • Session Parameters
    • Advanced Privacy & Anti-Detection
      • Stealth Mode
      • Proxies
      • Static IPs
      • CAPTCHA Solving
      • Ad Blocking
    • Profiles
    • Recordings
    • Live View
    • Extensions
    • Downloads
  • Guides
    • Model Context Protocol
    • Scraping
    • AI Function Calling
    • Extract Information with an LLM
    • Using Hyperbrowser Session
    • CAPTCHA Solving
  • Integrations
    • ⛓️LangChain
    • 🦙LlamaIndex
  • reference
    • Pricing
    • SDKs
      • Node
        • Sessions
        • Profiles
        • Scrape
        • Crawl
        • Extensions
      • Python
        • Sessions
        • Profiles
        • Scrape
        • Crawl
        • Extensions
    • API Reference
      • Sessions
      • Scrape
      • Crawl
      • Extract
      • Agents
        • Browser Use
        • Claude Computer Use
        • OpenAI CUA
      • Profiles
      • Extensions
Powered by GitBook
On this page
Export as PDF
  1. reference
  2. API Reference
  3. Agents

Claude Computer Use

PreviousBrowser UseNextOpenAI CUA

Last updated 23 days ago

Stop a claude computer use task

put
Authorizations
Path parameters
idstringRequired
Responses
200
Claude computer use task stopped successfully
application/json
put
PUT /api/task/claude-computer-use/{id}/stop HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
200

Claude computer use task stopped successfully

{
  "success": true
}

Get claude computer use task status

get
Authorizations
Path parameters
idstringRequired
Responses
200
Claude computer use task status
application/json
404
Claude computer use task not found
application/json
500
Server error
application/json
get
GET /api/task/claude-computer-use/{id}/status HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
  "status": "pending"
}
  • POSTStart a claude computer use task
  • GETGet claude computer use task status and results
  • PUTStop a claude computer use task
  • GETGet claude computer use task status

Get claude computer use task status and results

get
Authorizations
Path parameters
idstringRequired
Responses
200
Claude computer use task details
application/json
404
Claude computer use task not found
application/json
500
Server error
application/json
get
GET /api/task/claude-computer-use/{id} HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Accept: */*
{
  "jobId": "text",
  "status": "pending",
  "data": {
    "steps": [
      {}
    ],
    "finalResult": "text"
  },
  "error": "text",
  "liveUrl": "text"
}

Start a claude computer use task

post
Authorizations
Body
taskstringRequired
sessionIdstringOptional
maxFailuresnumberOptionalDefault: 3
maxStepsnumberOptionalDefault: 20
keepBrowserOpenbooleanOptionalDefault: false
Responses
200
Claude computer use task started successfully
application/json
500
Server error
application/json
post
POST /api/task/claude-computer-use HTTP/1.1
Host: app.hyperbrowser.ai
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 771

{
  "task": "text",
  "sessionId": "text",
  "maxFailures": 3,
  "maxSteps": 20,
  "keepBrowserOpen": false,
  "sessionOptions": {
    "useStealth": false,
    "useProxy": false,
    "proxyServer": "text",
    "proxyServerPassword": "text",
    "proxyServerUsername": "text",
    "proxyCountry": "AD",
    "proxyState": "AL",
    "proxyCity": "new york",
    "operatingSystems": [
      "windows"
    ],
    "device": [
      "desktop"
    ],
    "platform": [
      "chrome"
    ],
    "locales": [
      "aa"
    ],
    "screen": {
      "width": 1280,
      "height": 720
    },
    "solveCaptchas": false,
    "adblock": false,
    "trackers": false,
    "annoyances": false,
    "enableWebRecording": true,
    "profile": {
      "id": "text",
      "persistChanges": true
    },
    "acceptCookies": true,
    "extensionIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "urlBlocklist": [
      "text"
    ],
    "browserArgs": [
      "text"
    ],
    "imageCaptchaParams": [
      {
        "imageSelector": "text",
        "inputSelector": "text"
      }
    ],
    "timeoutMinutes": 1
  }
}
{
  "jobId": "text",
  "liveUrl": "text"
}