import { Hyperbrowser } from '@hyperbrowser/sdk';const client = new Hyperbrowser({ apiKey: 'your-api-key' });await client.agents.hyperAgent.start({ task: 'Find the price of the product', maxSteps: 20});
from hyperbrowser import Hyperbrowser
client = Hyperbrowser(api_key='your-api-key')
client.agents.hyper_agent.start({
"task": "Find the price of the product",
"max_steps": 20
})
import { Hyperbrowser } from '@hyperbrowser/sdk';const client = new Hyperbrowser({ apiKey: 'your-api-key' });await client.agents.hyperAgent.start({ task: 'Find the price of the product', maxSteps: 20});
from hyperbrowser import Hyperbrowser
client = Hyperbrowser(api_key='your-api-key')
client.agents.hyper_agent.start({
"task": "Find the price of the product",
"max_steps": 20
})
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/schema.json","name":"Hyperbrowser","colors":{"primary":"#000000","light":"#ffffff","dark":"#292929"},"logo":{"light":"https://mintcdn.com/s2labs/zKpTDqzfkiUOx-RW/logo/light.svg?fit=max\u0026auto=format\u0026n=zKpTDqzfkiUOx-RW\u0026q=85\u0026s=44630ff7088962766621163a05b33a9d","dark":"https://mintcdn.com/s2labs/zKpTDqzfkiUOx-RW/logo/dark.svg?fit=max\u0026auto=format\u0026n=zKpTDqzfkiUOx-RW\u0026q=85\u0026s=922ffa6a51f59c6d5a79b20d2b1ea484"},"favicon":"https://mintcdn.com/s2labs/PMe-Uqc-ack7u7Vf/favicon.ico?fit=max\u0026auto=format\u0026n=PMe-Uqc-ack7u7Vf\u0026q=85\u0026s=11222c1d22f5e03ce33c9288e8664b52","navbar":{"links":[{"href":"https://github.com/hyperbrowserai","label":"GitHub"},{"href":"mailto:info@hyperbrowser.ai","label":"Support"},{"href":"https://discord.gg/zsYzsgVRjh","label":"Discord"}],"primary":{"type":"button","label":"Get Started","href":"https://app.hyperbrowser.ai"}},"footer":{"socials":{"x":"https://x.com/hyperbrowser","github":"https://github.com/hyperbrowserai"}},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-Q79ZY3FMTL"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"s2labs","hasAudioNarration":false,"actualSubdomain":"s2labs","customDomains":["hyperbrowser.ai"],"gitSource":{"type":"github","owner":"hyperbrowserai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae259da911be5d0758acae8","collectionId":"bcaed162-8b68-4eea-8c7f-c7b6ded95672","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae259da911be5d0758acae8"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae259da911be5d0758acae8","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API reference","count":111},{"language":"default","tag":"Browsers","count":60},{"language":"default","tag":"Sandboxes","count":35},{"language":"default","tag":"Sandbox","count":13},{"language":"default","tag":"Session Configuration","count":12},{"language":"default","tag":"HyperAgent Usage","count":11},{"language":"default","tag":"Sessions","count":10},{"language":"default","tag":"Agents","count":9},{"language":"default","tag":"X402","count":9},{"language":"default","tag":"Web API","count":9}]},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":true,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".quick-start-cards img{height:200px!important;width:100%!important;object-fit:contain!important;object-position:center!important;padding:8px!important;margin-top:8px!important;background-color:#ffffff!important;border-radius:8px!important;overflow:hidden!important;box-shadow:none!important}.dark .card img{background-color:#0E0E0C!important}.dark .card img[src*=\"browser-sessions-home.png\"]{content:url(\"./images/browser-sessions-home-dark.png\")!important}.dark .card img[src*=\"web-scraping-home.png\"]{content:url(\"./images/web-scraping-home-dark.png\")!important}.dark .card img[src*=\"ai-agents-home.png\"]{content:url(\"./images/ai-agents-home-dark.png\")!important}.dark h1 img[src*=\"hyperbrowser-text-light.svg\"]{content:url(\"./images/hyperbrowser-text-dark.svg\")!important}.header-logo{height:48px!important;width:auto!important}@media (min-width: 1280px){#content-side-layout{min-height:0!important}#table-of-contents-layout{display:flex!important;flex:1 1 auto!important;min-height:0!important;max-height:100%!important}#table-of-contents{flex:1 1 auto!important;min-height:0!important;max-height:100%!important;overflow-y:auto!important;overscroll-behavior:contain;scrollbar-gutter:stable}}"}],"page":{"pagePath":"api-reference/start-a-hyperagent-task","slug":"/api-reference/start-a-hyperagent-task","pageMetadata":{"title":"Start a HyperAgent task","openapi":"openapi.json POST /api/task/hyper-agent","description":null,"href":"/api-reference/start-a-hyperagent-task"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start a HyperAgent task","openapi":"openapi.json POST /api/task/hyper-agent","description":null,"href":"/api-reference/start-a-hyperagent-task"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/s2labs/de6bdc86f5a23ffe/referrer.js","/docs/_mintlify/custom/s2labs/bcb74546631563cb/toc-scroll.js"],"openApiReferenceData":{"operation":{"summary":"Start a HyperAgent task","security":["124ab038-2c06-4ea6-a7d4-3157c96f02ba"],"x-codeSamples":[{"lang":"javascript","label":"Start HyperAgent task","source":"import { Hyperbrowser } from '@hyperbrowser/sdk';\n\nconst client = new Hyperbrowser({ apiKey: 'your-api-key' });\n\nawait client.agents.hyperAgent.start({\n task: 'Find the price of the product',\n maxSteps: 20\n});"},{"lang":"python","label":"Start HyperAgent task","source":"from hyperbrowser import Hyperbrowser\n\nclient = Hyperbrowser(api_key='your-api-key')\n\nclient.agents.hyper_agent.start({\n \"task\": \"Find the price of the product\",\n \"max_steps\": 20\n})"}],"requestBody":"0e8b111b-1e37-4ae6-bcda-40efc5d757f5","responses":{"200":"dd3713e0-19d2-4b73-9d83-115c61c64bf1","500":"18bc17ad-3747-4ea5-9bef-7e116ab505e6"},"method":"post","type":"path","servers":["5a0a3a2d-31c0-4cae-bb81-92e65574b146"],"path":"/api/task/hyper-agent","baseUrlOptions":["https://api.hyperbrowser.ai"],"title":"Start a HyperAgent task","description":"","codeSamples":[{"label":"Start HyperAgent task","lang":"javascript","source":"import { Hyperbrowser } from '@hyperbrowser/sdk';\n\nconst client = new Hyperbrowser({ apiKey: 'your-api-key' });\n\nawait client.agents.hyperAgent.start({\n task: 'Find the price of the product',\n maxSteps: 20\n});"},{"label":"Start HyperAgent task","lang":"python","source":"from hyperbrowser import Hyperbrowser\n\nclient = Hyperbrowser(api_key='your-api-key')\n\nclient.agents.hyper_agent.start({\n \"task\": \"Find the price of the product\",\n \"max_steps\": 20\n})"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"task":{"type":"string","isRequired":true,"uniqueKey":"task","typeLabel":"string"},"version":{"type":"string","enum":["0.8.0","1.1.0"],"default":"0.8.0","uniqueKey":"version","typeLabel":"enum\u003cstring>"},"llm":{"type":"string","enum":["gpt-6-luna","gpt-5.6-luna","gpt-5.5","gpt-5.2","gpt-5.1","gpt-5","gpt-5-mini","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.5-flash","gemini-3.8-flash","gemini-3.7-flash","gemini-3-flash-preview"],"default":"gpt-4o","uniqueKey":"llm","typeLabel":"enum\u003cstring>"},"sessionId":{"type":"string","uniqueKey":"sessionId","typeLabel":"string"},"maxSteps":{"type":"number","default":20,"uniqueKey":"maxSteps","typeLabel":"number"},"keepBrowserOpen":{"type":"boolean","default":false,"uniqueKey":"keepBrowserOpen","typeLabel":"boolean"},"sessionOptions":{"type":"object","properties":{"useUltraStealth":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.useUltraStealth","typeLabel":"boolean"},"useStealth":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.useStealth","typeLabel":"boolean"},"useProxy":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.useProxy","typeLabel":"boolean"},"proxyServer":{"type":"string","description":"Custom proxy server host.","uniqueKey":"sessionOptions.proxyServer","typeLabel":"string"},"proxyServerPassword":{"type":"string","description":"Password for authenticating with the custom proxy server.","uniqueKey":"sessionOptions.proxyServerPassword","typeLabel":"string"},"proxyServerUsername":{"type":"string","description":"Username for authenticating with the custom proxy server.","uniqueKey":"sessionOptions.proxyServerUsername","typeLabel":"string"},"proxyCountry":{"type":"string","enum":["AD","AE","AF","AL","AM","AO","AR","AT","AU","AW","AZ","BA","BD","BE","BG","BH","BJ","BO","BR","BS","BT","BY","BZ","CA","CF","CH","CI","CL","CM","CN","CO","CR","CU","CY","CZ","DE","DJ","DK","DM","EC","EE","EG","ES","ET","EU","FI","FJ","FR","GB","GE","GH","GM","GR","HK","HN","HR","HT","HU","ID","IE","IL","IN","IQ","IR","IS","IT","JM","JO","JP","KE","KH","KR","KW","KZ","LB","LI","LR","LT","LU","LV","MA","MC","MD","ME","MG","MK","ML","MM","MN","MR","MT","MU","MV","MX","MY","MZ","NG","NL","NO","NZ","OM","PA","PE","PH","PK","PL","PR","PT","PY","QA","RANDOM_COUNTRY","RO","RS","RU","SA","SC","SD","SE","SG","SI","SK","SN","SS","TD","TG","TH","TM","TN","TR","TT","TW","UA","UG","US","UY","UZ","VE","VG","VN","YE","ZA","ZM","ZW","ad","ae","af","al","am","ao","ar","at","au","aw","az","ba","bd","be","bg","bh","bj","bo","br","bs","bt","by","bz","ca","cf","ch","ci","cl","cm","cn","co","cr","cu","cy","cz","de","dj","dk","dm","ec","ee","eg","es","et","eu","fi","fj","fr","gb","ge","gh","gm","gr","hk","hn","hr","ht","hu","id","ie","il","in","iq","ir","is","it","jm","jo","jp","ke","kh","kr","kw","kz","lb","li","lr","lt","lu","lv","ma","mc","md","me","mg","mk","ml","mm","mn","mr","mt","mu","mv","mx","my","mz","ng","nl","no","nz","om","pa","pe","ph","pk","pl","pr","pt","py","qa","ro","rs","ru","sa","sc","sd","se","sg","si","sk","sn","ss","td","tg","th","tm","tn","tr","tt","tw","ua","ug","us","uy","uz","ve","vg","vn","ye","za","zm","zw"],"uniqueKey":"sessionOptions.proxyCountry","typeLabel":"enum\u003cstring>"},"proxyState":{"oneOf":[{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","al","ak","az","ar","ca","co","ct","de","fl","ga","hi","id","il","in","ia","ks","ky","la","me","md","ma","mi","mn","ms","mo","mt","ne","nv","nh","nj","nm","ny","nc","nd","oh","ok","or","pa","ri","sc","sd","tn","tx","ut","vt","va","wa","wv","wi","wy"],"description":"Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.","uniqueKey":"sessionOptions.proxyState.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY","al","ak","az","ar","ca","co","ct","de","fl","ga","hi","id","il","in","ia","ks","ky","la","me","md","ma","mi","mn","ms","mo","mt","ne","nv","nh","nj","nm","ny","nc","nd","oh","ok","or","pa","ri","sc","sd","tn","tx","ut","vt","va","wa","wv","wi","wy"],"description":"Optional state code for proxies to US states. Is mutually exclusive with proxyCity. Takes in two letter state code.","uniqueKey":"sessionOptions.proxyState.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionOptions.proxyState","typeLabel":"enum\u003cstring> | null"},"proxyCity":{"oneOf":[{"type":"string","example":"new york","description":"Desired Country. Is mutually exclusive with proxyState. Some cities might not be supported, so before using a new city, we recommend trying it out","uniqueKey":"sessionOptions.proxyCity.oneOf.0","typeLabel":"string"},{"type":"null","example":"new york","description":"Desired Country. Is mutually exclusive with proxyState. Some cities might not be supported, so before using a new city, we recommend trying it out","uniqueKey":"sessionOptions.proxyCity.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionOptions.proxyCity","typeLabel":"string | null"},"region":{"type":"string","description":"Region to run the session in. The asia-south region is only available on Enterprise and Select plans. Get in touch at https://calendly.com/shri-hyperbrowser/demo.","enum":["us","us-central","us-west","us-east","asia-south","europe-west"],"uniqueKey":"sessionOptions.region","typeLabel":"enum\u003cstring>"},"operatingSystems":{"type":"array","items":{"type":"string","enum":["windows","android","macos","linux","ios"],"uniqueKey":"sessionOptions.operatingSystems.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"sessionOptions.operatingSystems","typeLabel":"enum\u003cstring>[]"},"device":{"type":"array","items":{"type":"string","enum":["desktop","mobile"],"uniqueKey":"sessionOptions.device.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"sessionOptions.device","typeLabel":"enum\u003cstring>[]"},"platform":{"type":"array","items":{"type":"string","enum":["chrome","firefox","safari","edge"],"uniqueKey":"sessionOptions.platform.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"sessionOptions.platform","typeLabel":"enum\u003cstring>[]"},"locales":{"type":"array","items":{"type":"string","enum":["aa","ab","ae","af","ak","am","an","ar","as","av","ay","az","ba","be","bg","bh","bi","bm","bn","bo","br","bs","ca","ce","ch","co","cr","cs","cu","cv","cy","da","de","dv","dz","ee","el","en","eo","es","et","eu","fa","ff","fi","fj","fo","fr","fy","ga","gd","gl","gn","gu","gv","ha","he","hi","ho","hr","ht","hu","hy","hz","ia","id","ie","ig","ii","ik","io","is","it","iu","ja","jv","ka","kg","ki","kj","kk","kl","km","kn","ko","kr","ks","ku","kv","kw","ky","la","lb","lg","li","ln","lo","lt","lu","lv","mg","mh","mi","mk","ml","mn","mo","mr","ms","mt","my","na","nb","nd","ne","ng","nl","nn","no","nr","nv","ny","oc","oj","om","or","os","pa","pi","pl","ps","pt","qu","rm","rn","ro","ru","rw","sa","sc","sd","se","sg","si","sk","sl","sm","sn","so","sq","sr","ss","st","su","sv","sw","ta","te","tg","th","ti","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","wo","xh","yi","yo","za","zh","zu"],"uniqueKey":"sessionOptions.locales.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":["en"],"uniqueKey":"sessionOptions.locales","typeLabel":"enum\u003cstring>[]"},"screen":{"type":"object","properties":{"width":{"type":"number","default":1280,"uniqueKey":"sessionOptions.screen.width","typeLabel":"number"},"height":{"type":"number","default":720,"uniqueKey":"sessionOptions.screen.height","typeLabel":"number"}},"uniqueKey":"sessionOptions.screen","typeLabel":"object"},"solveCaptchas":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.solveCaptchas","typeLabel":"boolean"},"solverType":{"type":"string","enum":["visual"],"description":"Optional CAPTCHA solver mode. Set to visual to use the visual reCAPTCHA solver.","uniqueKey":"sessionOptions.solverType","typeLabel":"enum\u003cstring>"},"adblock":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.adblock","typeLabel":"boolean"},"trackers":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.trackers","typeLabel":"boolean"},"annoyances":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.annoyances","typeLabel":"boolean"},"enableWebRecording":{"type":"boolean","uniqueKey":"sessionOptions.enableWebRecording","typeLabel":"boolean"},"enableVideoWebRecording":{"type":"boolean","default":false,"description":"enableWebRecording must also be true for this to work","uniqueKey":"sessionOptions.enableVideoWebRecording","typeLabel":"boolean"},"profile":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"sessionOptions.profile.id","typeLabel":"string"},"persistChanges":{"type":"boolean","uniqueKey":"sessionOptions.profile.persistChanges","typeLabel":"boolean"},"persistNetworkCache":{"type":"boolean","description":"When persisting profile changes, also persist the browser's network cache (HTTP cache).","uniqueKey":"sessionOptions.profile.persistNetworkCache","typeLabel":"boolean"}},"uniqueKey":"sessionOptions.profile","typeLabel":"object"},"acceptCookies":{"type":"boolean","uniqueKey":"sessionOptions.acceptCookies","typeLabel":"boolean"},"staticIpId":{"type":"string","format":"uuid","uniqueKey":"sessionOptions.staticIpId","typeLabel":"string\u003cuuid>"},"saveDownloads":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.saveDownloads","typeLabel":"boolean"},"extensionIds":{"type":"array","items":{"type":"string","format":"uuid","nullable":false,"uniqueKey":"sessionOptions.extensionIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"default":[],"uniqueKey":"sessionOptions.extensionIds","typeLabel":"string\u003cuuid>[]"},"urlBlocklist":{"type":"array","items":{"type":"string","nullable":false,"uniqueKey":"sessionOptions.urlBlocklist.items.[INDEX]","typeLabel":"string"},"default":[],"uniqueKey":"sessionOptions.urlBlocklist","typeLabel":"string[]"},"browserArgs":{"type":"array","items":{"type":"string","nullable":false,"uniqueKey":"sessionOptions.browserArgs.items.[INDEX]","typeLabel":"string"},"default":[],"uniqueKey":"sessionOptions.browserArgs","typeLabel":"string[]"},"imageCaptchaParams":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"imageSelector":{"type":"string","uniqueKey":"sessionOptions.imageCaptchaParams.oneOf.0.items.[INDEX].imageSelector","typeLabel":"string"},"inputSelector":{"type":"string","uniqueKey":"sessionOptions.imageCaptchaParams.oneOf.0.items.[INDEX].inputSelector","typeLabel":"string"}},"uniqueKey":"sessionOptions.imageCaptchaParams.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"sessionOptions.imageCaptchaParams.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"imageSelector":{"type":"string"},"inputSelector":{"type":"string"}}},"uniqueKey":"sessionOptions.imageCaptchaParams.oneOf.1","typeLabel":"null"}],"uniqueKey":"sessionOptions.imageCaptchaParams","typeLabel":"object[] | null"},"timeoutMinutes":{"type":"number","minimum":1,"maximum":720,"uniqueKey":"sessionOptions.timeoutMinutes","typeLabel":"number"},"enableWindowManager":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.enableWindowManager","typeLabel":"boolean"},"enableWindowManagerTaskbar":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.enableWindowManagerTaskbar","typeLabel":"boolean"},"viewOnlyLiveView":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.viewOnlyLiveView","typeLabel":"boolean"},"disablePasswordManager":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.disablePasswordManager","typeLabel":"boolean"},"enableAlwaysOpenPdfExternally":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.enableAlwaysOpenPdfExternally","typeLabel":"boolean"},"disablePostQuantumKeyAgreement":{"type":"boolean","default":false,"uniqueKey":"sessionOptions.disablePostQuantumKeyAgreement","typeLabel":"boolean"},"enableWebMcp":{"type":"boolean","default":false,"description":"Enable discovery and invocation of WebMCP tools exposed by pages in this browser session. Must be set when creating the session; disabled by default.","uniqueKey":"sessionOptions.enableWebMcp","typeLabel":"boolean"},"credentials":{"type":"array","maxItems":20,"items":{"oneOf":[{"type":"string","description":"A secret's name.","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$","uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","required":["secret"],"properties":{"secret":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$","description":"A secret's name.","isRequired":true,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.1.secret","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["vault"],"properties":{"vault":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$","description":"A vault's name: attaches the secrets its entries point at now.","isRequired":true,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.2.vault","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["onePassword"],"properties":{"onePassword":{"type":"string","pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$","description":"An `op_token` secret's name: 1Password fills in this session may read with it. The token itself is never typed.","isRequired":true,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.3.onePassword","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"sessionOptions.credentials.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"sessionOptions.credentials.items.[INDEX]","typeLabel":"string · object · object · object"},"description":"Secrets the session may fill with POST /api/session/{id}/credentials/fill: a secret's name, `{\"secret\": name}`, `{\"vault\": name}` for the secrets a vault's entries point at, or `{\"onePassword\": name}` for an `op_token` secret that 1Password fills read with. You can only attach them when you create the session; an empty list is the same as none. Only `secret` and `totp` secrets can be attached as a name, `secret` or vault entry, and only an `op_token` as `onePassword`. Requires secrets to be enabled for your team; please contact support to enable them (otherwise 403 SECRETS_FEATURE_DISABLED), and, for restricted API keys, the secrets.use scope. The session runs on a Firecracker browser and Chrome's password manager is turned off. An unknown name returns 404 SECRET_NOT_FOUND or VAULT_NOT_FOUND, an `op_token` secret named as a credential, or a `onePassword` that isn't an `op_token`, 409 SECRET_TYPE_MISMATCH and a vault without entries 400 SECRET_SOURCES_INVALID. If the session can't run on Firecracker, you get 400 CREDENTIALS_UNSUPPORTED_RUNTIME, or 429 when no Firecracker host is free (retry shortly). Restoring a browser snapshot taken with the password manager on returns 400 CREDENTIALS_SNAPSHOT_PASSWORD_MANAGER_ENABLED.","uniqueKey":"sessionOptions.credentials","typeLabel":"string · object · object · object[]"},"webBotAuth":{"oneOf":[{"type":"boolean","description":"Sign the session's requests with [Web Bot Auth](/sessions/web-bot-auth) so websites can verify that they come from Hyperbrowser. Pass `{\"onlyDomains\": [...]}` to sign only for those hosts. Available on request: contact info@hyperbrowser.ai to get access. Supported when creating a session and for agent tasks; scrape, crawl, and extract reject it. Cannot be combined with `useUltraStealth` or `startFromSnapshot`.","uniqueKey":"sessionOptions.webBotAuth.oneOf.0","typeLabel":"boolean"},{"type":"object","description":"Sign the session's requests with [Web Bot Auth](/sessions/web-bot-auth) so websites can verify that they come from Hyperbrowser. Pass `{\"onlyDomains\": [...]}` to sign only for those hosts. Available on request: contact info@hyperbrowser.ai to get access. Supported when creating a session and for agent tasks; scrape, crawl, and extract reject it. Cannot be combined with `useUltraStealth` or `startFromSnapshot`.","properties":{"onlyDomains":{"type":"array","items":{"type":"string","uniqueKey":"sessionOptions.webBotAuth.oneOf.1.onlyDomains.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":50,"description":"Sign only requests to these hostnames (for example `example.com`) and their subdomains. No scheme, port, or path.","uniqueKey":"sessionOptions.webBotAuth.oneOf.1.onlyDomains","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"sessionOptions.webBotAuth.oneOf.1","typeLabel":"object"}],"uniqueKey":"sessionOptions.webBotAuth","typeLabel":"boolean | object"},"proxyRoutes":{"type":"array","maxItems":32,"items":{"type":"object","additionalProperties":false,"required":["match","proxy"],"description":"Sends traffic for matching hosts through the session's proxy or straight out.","properties":{"match":{"oneOf":[{"type":"string","description":"A hostname, `*.example.com` (subdomains, not `example.com` itself), or `*` (every host), or a list of them. Ports, URLs, and IP addresses are not accepted.","isRequired":true,"uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX].match.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX].match.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"A hostname, `*.example.com` (subdomains, not `example.com` itself), or `*` (every host), or a list of them. Ports, URLs, and IP addresses are not accepted.","minItems":1,"isRequired":true,"uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX].match.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX].match","typeLabel":"string | string[]"},"proxy":{"type":"string","enum":["direct","default"],"description":"`direct` sends the traffic straight out of the browser's machine; `default` sends it through the session's proxy.","isRequired":true,"uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX].proxy","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sessionOptions.proxyRoutes.items.[INDEX]","typeLabel":"object"},"description":"Choose, per host, whether traffic goes through the session's proxy or straight out. The first route that matches a host decides; hosts that no route matches use the proxy. At most 128 patterns across all routes. Requires `useProxy`. Available on request: contact info@hyperbrowser.ai to get access. See [proxy routes](/sessions/proxy-routes). Only supported when creating a session; cannot be combined with `allowInternetAccess: false`, `allowOut`, or `denyOut`.","uniqueKey":"sessionOptions.proxyRoutes","typeLabel":"object[]"}},"default":{"useStealth":false,"useProxy":false,"acceptCookies":false},"uniqueKey":"sessionOptions","typeLabel":"object"},"useCustomApiKeys":{"type":"boolean","default":false,"uniqueKey":"useCustomApiKeys","typeLabel":"boolean"},"apiKeys":{"type":"object","properties":{"openai":{"type":"string","uniqueKey":"apiKeys.openai","typeLabel":"string"},"anthropic":{"type":"string","uniqueKey":"apiKeys.anthropic","typeLabel":"string"},"google":{"type":"string","uniqueKey":"apiKeys.google","typeLabel":"string"}},"uniqueKey":"apiKeys","typeLabel":"object"}},"required":["task"],"default":{"task":"go to example.com"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"task":"go to example.com"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"dd3713e0-19d2-4b73-9d83-115c61c64bf1":{"description":"HyperAgent task started successfully","content":{"application/json":{"schema":{"type":"object","properties":{"jobId":{"type":"string","isRequired":true,"uniqueKey":"jobId","typeLabel":"string"},"liveUrl":{"oneOf":[{"type":"string","uniqueKey":"liveUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"liveUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"liveUrl","typeLabel":"string | null"}},"required":["jobId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"jobId":"\u003cstring>","liveUrl":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"18bc17ad-3747-4ea5-9bef-7e116ab505e6":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"124ab038-2c06-4ea6-a7d4-3157c96f02ba":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"5a0a3a2d-31c0-4cae-bb81-92e65574b146":{"url":"https://api.hyperbrowser.ai","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"s2labs","siteName":"Hyperbrowser","title":"Start a HyperAgent task - Hyperbrowser","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T20:24:04.036Z","originalFileLocation":"api-reference/start-a-hyperagent-task.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperbrowser\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start a HyperAgent task - Hyperbrowser\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperbrowser\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://s2labs.mintlify.site/docs/_mintlify/api/og/v2?division=HyperAgent\u0026amp;title=Start+a+HyperAgent+task\u0026amp;theme=2c486d60a6812ac847af32e3\u0026amp;signature=0b21be837df9adbfc8db1ef9ae35a73f63b2c6805a2ac42cbd42de433b3792c4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start a HyperAgent task - Hyperbrowser\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://s2labs.mintlify.site/docs/_mintlify/api/og/v2?division=HyperAgent\u0026amp;title=Start+a+HyperAgent+task\u0026amp;theme=2c486d60a6812ac847af32e3\u0026amp;signature=0b21be837df9adbfc8db1ef9ae35a73f63b2c6805a2ac42cbd42de433b3792c4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/s2labs/EYHRrnGU8YxO5yHy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperbrowser\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/start-a-hyperagent-task.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hyperbrowser.ai/#organization\",\"name\":\"Hyperbrowser\",\"url\":\"https://hyperbrowser.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/s2labs/zKpTDqzfkiUOx-RW/logo/light.svg?fit=max\u0026auto=format\u0026n=zKpTDqzfkiUOx-RW\u0026q=85\u0026s=44630ff7088962766621163a05b33a9d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://hyperbrowser.ai/docs#website\",\"name\":\"Hyperbrowser\",\"url\":\"https://hyperbrowser.ai/docs\",\"publisher\":{\"@id\":\"https://hyperbrowser.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task#webpage\",\"url\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task\",\"name\":\"Start a HyperAgent task\",\"dateModified\":\"2026-10-28T20:24:04.036Z\",\"isPartOf\":{\"@id\":\"https://hyperbrowser.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hyperbrowser\",\"item\":\"https://hyperbrowser.ai/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start a HyperAgent task\",\"item\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task#apireference\",\"headline\":\"Start a HyperAgent task\",\"name\":\"Start a HyperAgent task\",\"url\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task\",\"mainEntityOfPage\":{\"@id\":\"https://hyperbrowser.ai/docs/api-reference/start-a-hyperagent-task#webpage\"},\"dateModified\":\"2026-10-28T20:24:04.036Z\",\"publisher\":{\"@id\":\"https://hyperbrowser.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://hyperbrowser.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperbrowser\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hyperbrowser","nav":{"global":null,"tabs":[{"tab":"Home","icon":"home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Browsers","icon":"browser","pages":[{"title":"Browsers","href":"/introduction"}]},{"tab":"Sandboxes","icon":"server","pages":[{"title":"Sandboxes","href":"/sandboxes/introduction"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Sessions","icon":"window","pages":[{"title":"Create new session","openapi":"openapi.json POST /api/session","href":"/api-reference/create-new-session"},{"title":"Get session by ID","openapi":"openapi.json GET /api/session/{id}","href":"/api-reference/get-session-by-id"},{"title":"Stop a session","openapi":"openapi.json PUT /api/session/{id}/stop","href":"/api-reference/stop-a-session"},{"title":"Update a running session","openapi":"openapi.json PUT /api/session/{id}/update","href":"/api-reference/update-a-running-session"},{"title":"Run manual CAPTCHA evaluation","openapi":"openapi.json POST /api/session/{id}/captcha/evaluate","href":"/api-reference/manually-evaluate-captcha"},{"title":"Get list of sessions","openapi":"openapi.json GET /api/sessions","href":"/api-reference/get-list-of-sessions"},{"title":"Get session recording URL","openapi":"openapi.json GET /api/session/{id}/recording-url","href":"/api-reference/get-session-recording-url"},{"title":"Get session video recording URL","openapi":"openapi.json GET /api/session/{id}/video-recording-url","href":"/api-reference/get-session-video-recording-url"},{"title":"Get session downloads URL","openapi":"openapi.json GET /api/session/{id}/downloads-url","href":"/api-reference/get-session-downloads-url"},{"title":"Fill a credential","openapi":"openapi.json POST /api/session/{id}/credentials/fill","href":"/api-reference/fill-a-credential"}]},{"group":"WebMCP","icon":"wrench","pages":[{"title":"List WebMCP tools","openapi":"openapi.json GET /api/session/{id}/webmcp/tools","href":"/api-reference/list-webmcp-tools"},{"title":"Invoke a WebMCP tool","openapi":"openapi.json POST /api/session/{id}/webmcp/invoke","href":"/api-reference/invoke-webmcp-tool"},{"title":"Start a WebMCP invocation","openapi":"openapi.json POST /api/session/{id}/webmcp/invocations","href":"/api-reference/start-webmcp-invocation"},{"title":"Get a WebMCP invocation result","openapi":"openapi.json GET /api/session/{id}/webmcp/invocations/{invocationId}","href":"/api-reference/get-webmcp-invocation-result"},{"title":"Cancel a WebMCP invocation","openapi":"openapi.json POST /api/session/{id}/webmcp/invocations/{invocationId}/cancel","href":"/api-reference/cancel-webmcp-invocation"}]},{"group":"Profiles","icon":"user-circle","pages":[{"title":"Creates a new profile","openapi":"openapi.json POST /api/profile","href":"/api-reference/creates-a-new-profile"},{"title":"Get profile by ID","openapi":"openapi.json GET /api/profile/{id}","href":"/api-reference/get-profile-by-id"},{"title":"Delete profile by ID","openapi":"openapi.json DELETE /api/profile/{id}","href":"/api-reference/delete-profile-by-id"},{"title":"Get list of profiles","openapi":"openapi.json GET /api/profiles","href":"/api-reference/get-list-of-profiles"}]},{"group":"Secrets","icon":"key","pages":[{"title":"Get the secrets public key","openapi":"openapi.json GET /api/secrets/public-key","href":"/api-reference/get-secrets-public-key"},{"title":"Get list of secrets","openapi":"openapi.json GET /api/secrets","href":"/api-reference/get-list-of-secrets"},{"title":"Create a secret","openapi":"openapi.json POST /api/secrets","href":"/api-reference/create-a-secret"},{"title":"Get secret by ID","openapi":"openapi.json GET /api/secrets/{id}","href":"/api-reference/get-secret-by-id"},{"title":"Update a secret","openapi":"openapi.json PATCH /api/secrets/{id}","href":"/api-reference/update-a-secret"},{"title":"Delete a secret","openapi":"openapi.json DELETE /api/secrets/{id}","href":"/api-reference/delete-a-secret"},{"title":"Add a secret version","openapi":"openapi.json POST /api/secrets/{id}/versions","href":"/api-reference/add-a-secret-version"},{"title":"Delete a secret version","openapi":"openapi.json DELETE /api/secrets/{id}/versions/{version}","href":"/api-reference/delete-a-secret-version"}]},{"group":"Vaults","icon":"vault","pages":[{"title":"Get list of vaults","openapi":"openapi.json GET /api/vaults","href":"/api-reference/get-list-of-vaults"},{"title":"Create a vault","openapi":"openapi.json POST /api/vaults","href":"/api-reference/create-a-vault"},{"title":"Get vault by ID","openapi":"openapi.json GET /api/vaults/{id}","href":"/api-reference/get-vault-by-id"},{"title":"Update a vault","openapi":"openapi.json PATCH /api/vaults/{id}","href":"/api-reference/update-a-vault"},{"title":"Delete a vault","openapi":"openapi.json DELETE /api/vaults/{id}","href":"/api-reference/delete-a-vault"}]},{"group":"Sandboxes","icon":"box","pages":[{"title":"Create new sandbox","openapi":"openapi.json POST /api/sandbox","href":"/api-reference/create-new-sandbox"},{"title":"Get sandbox by ID","openapi":"openapi.json GET /api/sandbox/{id}","href":"/api-reference/get-sandbox-by-id"},{"title":"Get list of sandboxes","openapi":"openapi.json GET /api/sandboxes","href":"/api-reference/get-list-of-sandboxes"},{"title":"Stop a sandbox","openapi":"openapi.json PUT /api/sandbox/{id}/stop","href":"/api-reference/stop-a-sandbox"},{"title":"Expose a sandbox port","openapi":"openapi.json POST /api/sandbox/{id}/expose","href":"/api-reference/expose-a-sandbox-port"},{"title":"Remove an exposed sandbox port","openapi":"openapi.json POST /api/sandbox/{id}/unexpose","href":"/api-reference/remove-an-exposed-sandbox-port"},{"title":"Create a sandbox memory snapshot","openapi":"openapi.json POST /api/sandbox/{id}/snapshot","href":"/api-reference/create-a-sandbox-memory-snapshot"},{"title":"Update sandbox network policy","openapi":"openapi.json PUT /api/sandbox/{id}/network","href":"/api-reference/update-sandbox-network-policy"},{"title":"Start a sandbox process with secrets","openapi":"openapi.json POST /api/sandbox/{id}/processes","href":"/api-reference/start-a-sandbox-process-with-secrets"}]},{"group":"Sandbox Volumes","icon":"hard-drive","pages":[{"title":"Create a volume","openapi":"openapi.json POST /api/volume","href":"/api-reference/create-a-volume"},{"title":"Get list of volumes","openapi":"openapi.json GET /api/volume","href":"/api-reference/get-list-of-volumes"},{"title":"Get volume by ID","openapi":"openapi.json GET /api/volume/{id}","href":"/api-reference/get-volume-by-id"},{"title":"Delete a volume","openapi":"openapi.json DELETE /api/volume/{key}","href":"/api-reference/delete-a-volume"}]},{"group":"Sandbox Images","icon":"layer-group","pages":[{"title":"Get list of sandbox images","openapi":"openapi.json GET /api/images","href":"/api-reference/get-list-of-sandbox-images"},{"title":"Delete sandbox image","openapi":"openapi.json DELETE /api/images/{key}","href":"/api-reference/delete-sandbox-image"},{"title":"Create an image build","openapi":"openapi.json POST /api/images/builds","href":"/api-reference/create-an-image-build"},{"title":"Get list of image builds","openapi":"openapi.json GET /api/images/builds","href":"/api-reference/get-list-of-image-builds"},{"title":"Get image build by ID","openapi":"openapi.json GET /api/images/builds/{buildId}","href":"/api-reference/get-image-build-by-id"},{"title":"Complete an image build upload","openapi":"openapi.json POST /api/images/builds/{buildId}/complete","href":"/api-reference/complete-an-image-build-upload"},{"title":"Cancel an image build","openapi":"openapi.json POST /api/images/builds/{buildId}/cancel","href":"/api-reference/cancel-an-image-build"}]},{"group":"Sandbox Snapshots","icon":"camera","pages":[{"title":"Get list of sandbox snapshots","openapi":"openapi.json GET /api/snapshots","href":"/api-reference/get-list-of-sandbox-snapshots"},{"title":"Get sandbox snapshot","openapi":"openapi.json GET /api/snapshots/{key}","href":"/api-reference/get-sandbox-snapshot"},{"title":"Delete sandbox snapshot","openapi":"openapi.json DELETE /api/snapshots/{key}","href":"/api-reference/delete-sandbox-snapshot"}]},{"group":"Web API","icon":"database","pages":[{"title":"Fetch a web page","openapi":"openapi.json POST /api/web/fetch","href":"/api-reference/fetch-a-web-page"},{"title":"Start a web crawl job","openapi":"openapi.json POST /api/web/crawl","href":"/api-reference/start-a-web-crawl-job"},{"title":"Get web crawl job results","openapi":"openapi.json GET /api/web/crawl/{id}","href":"/api-reference/get-web-crawl-job-results"},{"title":"Get web crawl job status","openapi":"openapi.json GET /api/web/crawl/{id}/status","href":"/api-reference/get-web-crawl-job-status"},{"title":"Search the web","openapi":"openapi.json POST /api/web/search","href":"/api-reference/search-the-web"}]},{"group":"Scrape","icon":"file-code","pages":[{"title":"Create new scrape job","openapi":"openapi.json POST /api/scrape","href":"/api-reference/create-new-scrape-job"},{"title":"Get scrape job status and result","openapi":"openapi.json GET /api/scrape/{id}","href":"/api-reference/get-scrape-job-status-and-result"},{"title":"Get scrape job status","openapi":"openapi.json GET /api/scrape/{id}/status","href":"/api-reference/get-scrape-job-status"},{"title":"Start a batch scrape job","openapi":"openapi.json POST /api/scrape/batch","href":"/api-reference/start-a-batch-scrape-job"},{"title":"Get batch scrape job status and results","openapi":"openapi.json GET /api/scrape/batch/{id}","href":"/api-reference/get-batch-scrape-job-status-and-results"},{"title":"Get batch scrape job status","openapi":"openapi.json GET /api/scrape/batch/{id}/status","href":"/api-reference/get-batch-scrape-job-status"}]},{"group":"Crawl","icon":"spider","pages":[{"title":"Start a crawl job","openapi":"openapi.json POST /api/crawl","href":"/api-reference/start-a-crawl-job"},{"title":"Get crawl job status and results","openapi":"openapi.json GET /api/crawl/{id}","href":"/api-reference/get-crawl-job-status-and-results"},{"title":"Get crawl job status","openapi":"openapi.json GET /api/crawl/{id}/status","href":"/api-reference/get-crawl-job-status"}]},{"group":"Extract","icon":"database","pages":[{"title":"Start an extract job","openapi":"openapi.json POST /api/extract","href":"/api-reference/start-an-extract-job"},{"title":"Get extract job status and results","openapi":"openapi.json GET /api/extract/{id}","href":"/api-reference/get-extract-job-status-and-results"},{"title":"Get extract job status","openapi":"openapi.json GET /api/extract/{id}/status","href":"/api-reference/get-extract-job-status"}]},{"group":"Extensions","icon":"puzzle-piece","pages":[{"title":"Add a new extension","openapi":"openapi.json POST /api/extensions/add","href":"/api-reference/add-a-new-extension"},{"title":"List all extensions","openapi":"openapi.json GET /api/extensions/list","description":null,"href":"/api-reference/list-all-extensions"}]},{"group":"HyperAgent","icon":"bolt","pages":[{"title":"Start a HyperAgent task","openapi":"openapi.json POST /api/task/hyper-agent","href":"/api-reference/start-a-hyperagent-task"},{"title":"Get HyperAgent task status and results","openapi":"openapi.json GET /api/task/hyper-agent/{id}","description":null,"href":"/api-reference/get-hyperagent-task-status-and-results"},{"title":"Stop a HyperAgent task","openapi":"openapi.json PUT /api/task/hyper-agent/{id}/stop","href":"/api-reference/stop-a-hyperagent-task"},{"title":"Get HyperAgent task status","openapi":"openapi.json GET /api/task/hyper-agent/{id}/status","href":"/api-reference/get-hyperagent-task-status"}]},{"group":"BrowserUse","icon":"compass","pages":[{"title":"Start a browser use task","openapi":"openapi.json POST /api/task/browser-use","href":"/api-reference/start-a-browser-use-task"},{"title":"Get browser use task status and results","openapi":"openapi.json GET /api/task/browser-use/{id}","href":"/api-reference/get-browser-use-task-status-and-results"},{"title":"Stop a browser use task","openapi":"openapi.json PUT /api/task/browser-use/{id}/stop","href":"/api-reference/stop-a-browser-use-task"},{"title":"Get browser use task status","openapi":"openapi.json GET /api/task/browser-use/{id}/status","href":"/api-reference/get-browser-use-task-status"}]},{"group":"Claude Computer Use","icon":"microchip-ai","pages":[{"title":"Start a claude computer use task","openapi":"openapi.json POST /api/task/claude-computer-use","href":"/api-reference/start-a-claude-computer-use-task"},{"title":"Get claude computer use task status and results","openapi":"openapi.json GET /api/task/claude-computer-use/{id}","href":"/api-reference/get-claude-computer-use-task-status-and-results"},{"title":"Stop a claude computer use task","openapi":"openapi.json PUT /api/task/claude-computer-use/{id}/stop","href":"/api-reference/stop-a-claude-computer-use-task"},{"title":"Get claude computer use task status","openapi":"openapi.json GET /api/task/claude-computer-use/{id}/status","href":"/api-reference/get-claude-computer-use-task-status"}]},{"group":"Gemini Computer Use","icon":"sparkles","pages":[{"title":"Start a gemini computer use task","openapi":"openapi.json POST /api/task/gemini-computer-use","href":"/api-reference/start-a-gemini-computer-use-task"},{"title":"Get gemini computer use task status and results","openapi":"openapi.json GET /api/task/gemini-computer-use/{id}","href":"/api-reference/get-gemini-computer-use-task-status-and-results"},{"title":"Stop a gemini computer use task","openapi":"openapi.json PUT /api/task/gemini-computer-use/{id}/stop","href":"/api-reference/stop-a-gemini-computer-use-task"},{"title":"Get gemini computer use task status","openapi":"openapi.json GET /api/task/gemini-computer-use/{id}/status","href":"/api-reference/get-gemini-computer-use-task-status"}]},{"group":"Meta Computer Use","icon":"microchip-ai","pages":[{"title":"Start a meta computer use task","openapi":"openapi.json POST /api/task/meta-computer-use","href":"/api-reference/start-a-meta-computer-use-task"},{"title":"Get meta computer use task status and results","openapi":"openapi.json GET /api/task/meta-computer-use/{id}","href":"/api-reference/get-meta-computer-use-task-status-and-results"},{"title":"Stop a meta computer use task","openapi":"openapi.json PUT /api/task/meta-computer-use/{id}/stop","href":"/api-reference/stop-a-meta-computer-use-task"},{"title":"Get meta computer use task status","openapi":"openapi.json GET /api/task/meta-computer-use/{id}/status","href":"/api-reference/get-meta-computer-use-task-status"}]},{"group":"Grok Computer Use","icon":"microchip-ai","pages":[{"title":"Start a grok computer use task","openapi":"openapi.json POST /api/task/grok-computer-use","href":"/api-reference/start-a-grok-computer-use-task"},{"title":"Get grok computer use task status and results","openapi":"openapi.json GET /api/task/grok-computer-use/{id}","href":"/api-reference/get-grok-computer-use-task-status-and-results"},{"title":"Stop a grok computer use task","openapi":"openapi.json PUT /api/task/grok-computer-use/{id}/stop","href":"/api-reference/stop-a-grok-computer-use-task"},{"title":"Get grok computer use task status","openapi":"openapi.json GET /api/task/grok-computer-use/{id}/status","href":"/api-reference/get-grok-computer-use-task-status"}]},{"group":"Jev Computer Use","icon":"microchip-ai","pages":[{"title":"Start a jev computer use task","openapi":"openapi.json POST /api/task/jev","href":"/api-reference/start-a-jev-computer-use-task"},{"title":"Get jev computer use task status and results","openapi":"openapi.json GET /api/task/jev/{id}","href":"/api-reference/get-jev-computer-use-task-status-and-results"},{"title":"Stop a jev computer use task","openapi":"openapi.json PUT /api/task/jev/{id}/stop","href":"/api-reference/stop-a-jev-computer-use-task"},{"title":"Get jev computer use task status","openapi":"openapi.json GET /api/task/jev/{id}/status","href":"/api-reference/get-jev-computer-use-task-status"}]},{"group":"OpenAI CUA","icon":"brain-circuit","pages":[{"title":"Start a CUA task","openapi":"openapi.json POST /api/task/cua","href":"/api-reference/start-a-cua-task"},{"title":"Get CUA task status and results","openapi":"openapi.json GET /api/task/cua/{id}","href":"/api-reference/get-cua-task-status-and-results"},{"title":"Stop a CUA task","openapi":"openapi.json PUT /api/task/cua/{id}/stop","href":"/api-reference/stop-a-cua-task"},{"title":"Get CUA task status","openapi":"openapi.json GET /api/task/cua/{id}/status","href":"/api-reference/get-cua-task-status"}]},{"group":"X402","icon":"coin","pages":[{"title":"Create a session with X402 payment","openapi":"openapi.json POST /x402/session","href":"/api-reference/create-a-session-with-x402-payment"},{"title":"Get an X402 session","openapi":"openapi.json GET /x402/session/{id}","href":"/api-reference/get-an-x402-session"},{"title":"Stop an X402 session","openapi":"openapi.json PUT /x402/session/{id}/stop","href":"/api-reference/stop-an-x402-session"},{"title":"Fetch a web page with X402 payment","openapi":"openapi.json POST /x402/web/fetch","href":"/api-reference/fetch-a-web-page-with-x402-payment"},{"title":"Search the web with X402 payment","openapi":"openapi.json POST /x402/web/search","href":"/api-reference/search-the-web-with-x402-payment"}]}]},{"tab":"SDKs","icon":"code","pages":[{"title":"SDKs","href":"/sdks/introduction"}]},{"tab":"Pricing","icon":"magnifying-glass-dollar","pages":[{"title":"Pricing","href":"/pricing"}]}]},"basePath":"","title":"Start a HyperAgent task - Hyperbrowser","buildId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","deploymentId":"dpl_CEsowfH15TDzsBT2BFbX312Be4Ct","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CqF8gK93.js","utils-Cfy66YIG.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-cadwlSiW.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BOSHrB55.js","snippetPresets-DuIJ6Tui.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CGry0O4L.js","ApiExamples-BByZ-4eP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DWD4BnjW.js","shallow-Bo7p10ck.js","getApiPlaygroundDisplay-C7mFZ2Cg.js","CodeSnippet-DrT8v8gt.js","CodeSnippets-DGLmtlSm.js","getPastedJson-DXZGgv-T.js","icon-DMjuBky8.js","MethodPill-C_c9VvF7.js","DuplicateIcon-D8Zrb3hW.js","createIcon-eYWxX-Sl.js","DynamicMarkdown-DORtg_Te.js","SectionHeading-DE1W9Ett.js","axios-vUo_bRtp.js","Markdown-BvSqw8zR.js","clsx-B-KWekQe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CTE3eEYy.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ba-QebqG.js"]}