Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token’s, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent’s own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.
waiting_person: the agent waits for a person (a take-over, a pause, a code or a sign-in it asked for). waiting_approval: something it wants to send waits for a yes. The last three are ended sessions.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sidenet API","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#4338CA"},"logo":{"light":"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-light.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=206c6acd674e00cc951ff99d54600daa","dark":"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=db3396c278572b71489a4c1be475acd4","href":"https://www.sidenet.ai"},"favicon":{"light":"https://mintcdn.com/sidenetai/bYiM267pd74qNSPc/images/3bc48416-a174-468b-9d1a-56046f8bb9b4.png?fit=max\u0026auto=format\u0026n=bYiM267pd74qNSPc\u0026q=85\u0026s=b651ac95041904f0eaf2678e8d2704ab","dark":"https://mintcdn.com/sidenetai/bYiM267pd74qNSPc/images/3bc48416-a174-468b-9d1a-56046f8bb9b4.png?fit=max\u0026auto=format\u0026n=bYiM267pd74qNSPc\u0026q=85\u0026s=b651ac95041904f0eaf2678e8d2704ab"},"api":{"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://www.sidenet.ai","label":"Back to website"},{"href":"https://www.sidenet.ai/book-demo/","label":"Book a demo"}],"primary":{"type":"button","label":"Sidenet Studio","href":"https://studio.sidenet.ai"}},"footer":{"socials":{"website":"https://www.sidenet.ai"}},"seo":{"metatags":{"canonical":"https://www.sidenet.ai"},"indexing":"all"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sidenetai","hasAudioNarration":false,"actualSubdomain":"sidenetai","customDomains":["sidenet.ai"],"gitSource":{"type":"github","owner":"alexdanan","repo":"sidenet-api","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af5926fbb452cd0b1daa92e","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":163},{"language":"default","tag":"Guides","count":23},{"language":"default","tag":"Browser","count":17},{"language":"default","tag":"Chat SDK","count":13},{"language":"default","tag":"Chat \u0026 Messaging","count":12},{"language":"default","tag":"Workflow Schedules","count":12},{"language":"default","tag":"Dashboards","count":11},{"language":"default","tag":"Networks","count":11},{"language":"default","tag":"Prompt Blocks","count":11},{"language":"default","tag":"Workflows","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"editor-metadata","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/browser/open-a-browser-session","slug":"/api-reference/browser/open-a-browser-session","pageMetadata":{"title":"Open a browser session","description":"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (`GET /v1/browser-sessions/{id}/live-view`). `url` is the page it opens on. `saved_login` (`{ ref, host }`, from `POST /v1/browser-sessions/{id}/keep-sign-in`) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and `url` must then be on that website. `metadata` is kept and returned as given. `thread_id` names the conversation the session is meant for and is kept in `metadata.thread_id`; the session joins a conversation when it is handed to an agent (`POST /v1/browser-sessions/{id}/attach`). The session belongs to the user of the call — a session token's, or the `X-User-Id` sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent's own session is not opened here: an agent whose version has `browser.enabled` opens one on its first browser step.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions","href":"/api-reference/browser/open-a-browser-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (\", _jsx(_components.code, {\n children: \"GET /v1/browser-sessions/{id}/live-view\"\n }), \"). \", _jsx(_components.code, {\n children: \"url\"\n }), \" is the page it opens on. \", _jsx(_components.code, {\n children: \"saved_login\"\n }), \" (\", _jsx(_components.code, {\n children: \"{ ref, host }\"\n }), \", from \", _jsx(_components.code, {\n children: \"POST /v1/browser-sessions/{id}/keep-sign-in\"\n }), \") signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and \", _jsx(_components.code, {\n children: \"url\"\n }), \" must then be on that website. \", _jsx(_components.code, {\n children: \"metadata\"\n }), \" is kept and returned as given. \", _jsx(_components.code, {\n children: \"thread_id\"\n }), \" names the conversation the session is meant for and is kept in \", _jsx(_components.code, {\n children: \"metadata.thread_id\"\n }), \"; the session joins a conversation when it is handed to an agent (\", _jsx(_components.code, {\n children: \"POST /v1/browser-sessions/{id}/attach\"\n }), \"). The session belongs to the user of the call — a session token’s, or the \", _jsx(_components.code, {\n children: \"X-User-Id\"\n }), \" sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent’s own session is not opened here: an agent whose version has \", _jsx(_components.code, {\n children: \"browser.enabled\"\n }), \" opens one on its first browser step.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":"Open a browser session","description":"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (`GET /v1/browser-sessions/{id}/live-view`). `url` is the page it opens on. `saved_login` (`{ ref, host }`, from `POST /v1/browser-sessions/{id}/keep-sign-in`) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and `url` must then be on that website. `metadata` is kept and returned as given. `thread_id` names the conversation the session is meant for and is kept in `metadata.thread_id`; the session joins a conversation when it is handed to an agent (`POST /v1/browser-sessions/{id}/attach`). The session belongs to the user of the call — a session token's, or the `X-User-Id` sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent's own session is not opened here: an agent whose version has `browser.enabled` opens one on its first browser step.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions","href":"/api-reference/browser/open-a-browser-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/sidenetai/8e3ad2809aba5c1a/analytics.js"],"openApiReferenceData":{"operation":{"summary":"Open a browser session","description":"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (`GET /v1/browser-sessions/{id}/live-view`). `url` is the page it opens on. `saved_login` (`{ ref, host }`, from `POST /v1/browser-sessions/{id}/keep-sign-in`) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and `url` must then be on that website. `metadata` is kept and returned as given. `thread_id` names the conversation the session is meant for and is kept in `metadata.thread_id`; the session joins a conversation when it is handed to an agent (`POST /v1/browser-sessions/{id}/attach`). The session belongs to the user of the call — a session token's, or the `X-User-Id` sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent's own session is not opened here: an agent whose version has `browser.enabled` opens one on its first browser step.","tags":["Browser"],"requestBody":"b1194c54-41b2-4f61-90ce-9f16d44c642d","responses":{"201":"8d16032a-bfa6-46d8-9e8c-447f595c8802","400":"887cbd93-203f-44ba-8d09-7ed2ca492ef0","404":"6a0f1a17-68c4-486f-9480-63ff302baf11","409":"aa9ffd1b-ca1f-405b-af38-c40b9872585e","502":"6cd7c6da-4eba-4fde-95c5-e8cf123d5208","503":"51938267-d320-4278-af08-3f192bf0ce94"},"parameters":[],"security":["a996e96b-d52b-4bd2-b15c-f2f01c045407","c260fa0a-7f56-46e5-a268-3f77950568c9"],"method":"post","type":"path","servers":["ba637bfa-1a19-4cb8-8673-ffacba1d383e"],"path":"/v1/browser-sessions","baseUrlOptions":["https://api.sidenet.ai"],"title":"Open a browser session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.url":"https://admin.booking.com","body.metadata":{"property_id":"5b0f…","object":{"kind":"reservation","id":"…"}}}]},"dependencies":{"parameters":{},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","example":"https://admin.booking.com","description":"The page to open.","uniqueKey":"url","typeLabel":"string"},"thread_id":{"type":"string","description":"The conversation this session is meant for (kept in `metadata.thread_id`).","uniqueKey":"thread_id","typeLabel":"string"},"saved_login":{"oneOf":[{"type":"object","properties":{"ref":{"type":"string","uniqueKey":"saved_login.oneOf.0.ref","typeLabel":"string"},"host":{"type":"string","uniqueKey":"saved_login.oneOf.0.host","typeLabel":"string"}},"description":"A saved login to sign the first tab in with.","uniqueKey":"saved_login.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"ref":{"type":"string"},"host":{"type":"string"}},"description":"A saved login to sign the first tab in with.","uniqueKey":"saved_login.oneOf.1","typeLabel":"null"}],"uniqueKey":"saved_login","typeLabel":"object | null"},"viewport":{"type":"object","properties":{"width":{"type":"integer","uniqueKey":"viewport.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"viewport.height","typeLabel":"integer"}},"description":"The size of the browser window (default 1280 × 800).","uniqueKey":"viewport","typeLabel":"object"},"metadata":{"type":"object","description":"Anything the caller wants back with the session.","uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"url":"https://admin.booking.com","metadata":{"property_id":"5b0f…","object":{"kind":"reservation","id":"…"}}},"examples":{"Example":{"title":"Example","value":{"url":"https://admin.booking.com","metadata":{"property_id":"5b0f…","object":{"kind":"reservation","id":"…"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"8d16032a-bfa6-46d8-9e8c-447f595c8802":{"description":"The session","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The session id. Sidenet's own: it is what every route here takes.","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["live","waiting_person","waiting_approval","done","stopped","failed"],"description":"`waiting_person`: the agent waits for a person (a take-over, a pause, a code or a sign-in it asked for). `waiting_approval`: something it wants to send waits for a yes. The last three are ended sessions.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"control":{"type":"string","enum":["person","agent"],"description":"Who may act on the page now.","uniqueKey":"control","typeLabel":"enum\u003cstring>"},"drivers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["person","agent"],"uniqueKey":"drivers.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"user_id":{"type":"string","uniqueKey":"drivers.items.[INDEX].user_id","typeLabel":"string"},"agent_id":{"type":"string","uniqueKey":"drivers.items.[INDEX].agent_id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"drivers.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"drivers.items.[INDEX]","typeLabel":"object"},"description":"Who works in the session.","uniqueKey":"drivers","typeLabel":"object[]"},"thread_id":{"oneOf":[{"type":"string","description":"The conversation the session works for; null for a session a person opened with no agent.","uniqueKey":"thread_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The conversation the session works for; null for a session a person opened with no agent.","uniqueKey":"thread_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"thread_id","typeLabel":"string | null"},"run_id":{"oneOf":[{"type":"string","description":"The request of the agent turn using it (its id in the requests list).","uniqueKey":"run_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The request of the agent turn using it (its id in the requests list).","uniqueKey":"run_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"run_id","typeLabel":"string | null"},"host":{"oneOf":[{"type":"string","description":"The website of the active tab.","uniqueKey":"host.oneOf.0","typeLabel":"string"},{"type":"null","description":"The website of the active tab.","uniqueKey":"host.oneOf.1","typeLabel":"null"}],"uniqueKey":"host","typeLabel":"string | null"},"saved_login":{"oneOf":[{"type":"object","properties":{"ref":{"type":"string","uniqueKey":"saved_login.oneOf.0.ref","typeLabel":"string"},"host":{"type":"string","uniqueKey":"saved_login.oneOf.0.host","typeLabel":"string"}},"description":"The saved login the session is signed in with, if any.","uniqueKey":"saved_login.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"ref":{"type":"string"},"host":{"type":"string"}},"description":"The saved login the session is signed in with, if any.","uniqueKey":"saved_login.oneOf.1","typeLabel":"null"}],"uniqueKey":"saved_login","typeLabel":"object | null"},"tabs":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","uniqueKey":"tabs.items.[INDEX].index","typeLabel":"integer"},"url":{"type":"string","uniqueKey":"tabs.items.[INDEX].url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"tabs.items.[INDEX].title","typeLabel":"string"},"active":{"type":"boolean","uniqueKey":"tabs.items.[INDEX].active","typeLabel":"boolean"},"agent":{"type":"boolean","description":"The tab the agent works in.","uniqueKey":"tabs.items.[INDEX].agent","typeLabel":"boolean"}},"uniqueKey":"tabs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tabs","typeLabel":"object[]"},"steps":{"type":"array","items":{"type":"object","properties":{"n":{"type":"integer","uniqueKey":"steps.items.[INDEX].n","typeLabel":"integer"},"of":{"oneOf":[{"type":"integer","uniqueKey":"steps.items.[INDEX].of.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"steps.items.[INDEX].of.oneOf.1","typeLabel":"null"}],"uniqueKey":"steps.items.[INDEX].of","typeLabel":"integer | null"},"sentence":{"type":"string","description":"What the agent did, in plain words.","uniqueKey":"steps.items.[INDEX].sentence","typeLabel":"string"},"tab":{"type":"integer","uniqueKey":"steps.items.[INDEX].tab","typeLabel":"integer"},"at":{"type":"string","format":"date-time","uniqueKey":"steps.items.[INDEX].at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"description":"The agent's steps, oldest first (the last 200).","uniqueKey":"steps","typeLabel":"object[]"},"needs_person":{"oneOf":[{"type":"string","enum":["code","captcha","sign_in",null],"description":"What the agent asked a person for.","uniqueKey":"needs_person.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["code","captcha","sign_in",null],"description":"What the agent asked a person for.","uniqueKey":"needs_person.oneOf.1","typeLabel":"null"}],"uniqueKey":"needs_person","typeLabel":"enum\u003cstring> | null"},"pending_submit":{"oneOf":[{"type":"object","properties":{"description":{"type":"string","uniqueKey":"pending_submit.oneOf.0.description","typeLabel":"string"},"host":{"type":"string","uniqueKey":"pending_submit.oneOf.0.host","typeLabel":"string"},"asked_at":{"type":"string","format":"date-time","uniqueKey":"pending_submit.oneOf.0.asked_at","typeLabel":"string\u003cdate-time>"},"decision_ref":{"oneOf":[{"type":"string","uniqueKey":"pending_submit.oneOf.0.decision_ref.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"pending_submit.oneOf.0.decision_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"pending_submit.oneOf.0.decision_ref","typeLabel":"string | null"}},"description":"What waits for a yes before it is sent.","uniqueKey":"pending_submit.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"description":{"type":"string"},"host":{"type":"string"},"asked_at":{"type":"string","format":"date-time"},"decision_ref":{"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"What waits for a yes before it is sent.","uniqueKey":"pending_submit.oneOf.1","typeLabel":"null"}],"uniqueKey":"pending_submit","typeLabel":"object | null"},"end":{"oneOf":[{"type":"object","properties":{"outcome":{"type":"string","enum":["done","stopped","failed"],"uniqueKey":"end.oneOf.0.outcome","typeLabel":"enum\u003cstring>"},"sentence":{"type":"string","uniqueKey":"end.oneOf.0.sentence","typeLabel":"string"}},"uniqueKey":"end.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"outcome":{"type":"string","enum":["done","stopped","failed"]},"sentence":{"type":"string"}},"uniqueKey":"end.oneOf.1","typeLabel":"null"}],"uniqueKey":"end","typeLabel":"object | null"},"metadata":{"type":"object","description":"Kept and returned as given at creation.","uniqueKey":"metadata","typeLabel":"object"},"started_at":{"type":"string","format":"date-time","uniqueKey":"started_at","typeLabel":"string\u003cdate-time>"},"ended_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"ended_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"ended_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"ended_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"bs_3f9a1c0e5b7d2a4c6e8f0b1d","status":"live","control":"person","drivers":[{"kind":"person","user_id":"user_42","name":"Person"}],"thread_id":null,"run_id":null,"host":"admin.booking.com","saved_login":{"ref":"sl_0c9e4b7a1d3f5a6b8c2e4d6f","host":"admin.booking.com"},"tabs":[{"index":0,"url":"https://admin.booking.com/hotel/hoteladmin/","title":"Booking.com extranet","active":true,"agent":true}],"steps":[],"needs_person":null,"pending_submit":null,"end":null,"metadata":{"property_id":"5b0f…"},"started_at":"2026-11-12T10:00:00.000Z","ended_at":null,"updated_at":"2026-11-12T10:00:03.000Z"},"examples":{"Example":{"title":"Example","value":{"id":"bs_3f9a1c0e5b7d2a4c6e8f0b1d","status":"live","control":"person","drivers":[{"kind":"person","user_id":"user_42","name":"Person"}],"thread_id":null,"run_id":null,"host":"admin.booking.com","saved_login":{"ref":"sl_0c9e4b7a1d3f5a6b8c2e4d6f","host":"admin.booking.com"},"tabs":[{"index":0,"url":"https://admin.booking.com/hotel/hoteladmin/","title":"Booking.com extranet","active":true,"agent":true}],"steps":[],"needs_person":null,"pending_submit":null,"end":null,"metadata":{"property_id":"5b0f…"},"started_at":"2026-11-12T10:00:00.000Z","ended_at":null,"updated_at":"2026-11-12T10:00:03.000Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"887cbd93-203f-44ba-8d09-7ed2ca492ef0":{"description":"Not a web address, an unknown field, or `url` outside the saved login's website","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"6a0f1a17-68c4-486f-9480-63ff302baf11":{"description":"No saved login with that reference","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"aa9ffd1b-ca1f-405b-af38-c40b9872585e":{"description":"The saved login is open in another session","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"6cd7c6da-4eba-4fde-95c5-e8cf123d5208":{"description":"The browser could not be opened","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"51938267-d320-4278-af08-3f192bf0ce94":{"description":"The browser is not set up on this platform","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a996e96b-d52b-4bd2-b15c-f2f01c045407":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.","scopes":[],"schemeName":"bearerAuth"}},"c260fa0a-7f56-46e5-a268-3f77950568c9":{"sessionToken":{"type":"http","scheme":"bearer","description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","scopes":[],"schemeName":"sessionToken"}}},"servers":{"ba637bfa-1a19-4cb8-8673-ffacba1d383e":{"url":"https://api.sidenet.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","scopes":[],"schemeName":"sessionToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Session token (`snat_…`) minted by POST /v1/token. Carries the organization and the end user; safe in a browser.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"sessionToken","name":"Authorization"}],"title":"sessionToken"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"sidenetai","siteName":"Sidenet API","title":"Open a browser session - Sidenet API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T10:18:31.187Z","originalFileLocation":"api-reference/browser/open-a-browser-session.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=\"description\" content=\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token\u0026#x27;s, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent\u0026#x27;s own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sidenet API\">\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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_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/sidenetai/jpMqiy2x92lioK32/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Open a browser session - Sidenet API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token\u0026#x27;s, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent\u0026#x27;s own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sidenet API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sidenetai.mintlify.site/docs/_mintlify/api/og/v2?division=Browser\u0026amp;title=Open+a+browser+session\u0026amp;description=Opens+a+browser+for+a+person%2C+with+no+agent%3A+a+remote+browser+running+in+the+EU+that+they+watch+and+drive+through+its+live+view+%28%60GET+%2Fv1%2Fbrowser-sessions%2F%7Bid%7D%2F\u0026amp;theme=a1e7f929b234304c081618fd\u0026amp;signature=3fa300779572931178a65487c9635ac33fcfea00b33ca56983d9d5522321a8c8\">\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=\"Open a browser session - Sidenet API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token\u0026#x27;s, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent\u0026#x27;s own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sidenetai.mintlify.site/docs/_mintlify/api/og/v2?division=Browser\u0026amp;title=Open+a+browser+session\u0026amp;description=Opens+a+browser+for+a+person%2C+with+no+agent%3A+a+remote+browser+running+in+the+EU+that+they+watch+and+drive+through+its+live+view+%28%60GET+%2Fv1%2Fbrowser-sessions%2F%7Bid%7D%2F\u0026amp;theme=a1e7f929b234304c081618fd\u0026amp;signature=3fa300779572931178a65487c9635ac33fcfea00b33ca56983d9d5522321a8c8\">\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/sidenetai/jpMqiy2x92lioK32/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sidenet API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session\">\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/browser/open-a-browser-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.sidenet.ai/#organization\",\"name\":\"Sidenet API\",\"url\":\"https://www.sidenet.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sidenetai/IsfHUeiSCKNFr_6U/images/logo-light.svg?fit=max\u0026auto=format\u0026n=IsfHUeiSCKNFr_6U\u0026q=85\u0026s=206c6acd674e00cc951ff99d54600daa\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.sidenet.ai#website\",\"name\":\"Sidenet API\",\"url\":\"https://www.sidenet.ai\",\"publisher\":{\"@id\":\"https://www.sidenet.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session#webpage\",\"url\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session\",\"name\":\"Open a browser session\",\"description\":\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token's, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent's own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.\",\"dateModified\":\"2026-11-12T10:18:31.187Z\",\"isPartOf\":{\"@id\":\"https://www.sidenet.ai#website\"},\"breadcrumb\":{\"@id\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sidenet API\",\"item\":\"https://www.sidenet.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Open a browser session\",\"item\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session#apireference\",\"headline\":\"Open a browser session\",\"name\":\"Open a browser session\",\"description\":\"Opens a browser for a person, with no agent: a remote browser running in the EU that they watch and drive through its live view (GET /v1/browser-sessions/{id}/live-view). url is the page it opens on. saved_login ({ ref, host }, from POST /v1/browser-sessions/{id}/keep-sign-in) signs the first tab in to that website; one saved login is open in one session at a time (409 otherwise), and url must then be on that website. metadata is kept and returned as given. thread_id names the conversation the session is meant for and is kept in metadata.thread_id; the session joins a conversation when it is handed to an agent (POST /v1/browser-sessions/{id}/attach). The session belongs to the user of the call — a session token's, or the X-User-Id sent with an API key — and ends when it is stopped or after ten minutes without activity. An agent's own session is not opened here: an agent whose version has browser.enabled opens one on its first browser step.\",\"url\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session\",\"mainEntityOfPage\":{\"@id\":\"https://www.sidenet.ai/api-reference/browser/open-a-browser-session#webpage\"},\"dateModified\":\"2026-11-12T10:18:31.187Z\",\"publisher\":{\"@id\":\"https://www.sidenet.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.sidenet.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sidenet API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sidenet API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/browser/open-a-browser-session.md","siteName":"Sidenet API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/concepts"}]},{"tab":"API Reference","groups":[{"group":"Overview","root":{"title":"Overview","href":"/api-reference/overview"},"pages":[]},{"group":"Authentication","pages":[{"title":"Mint session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/token","href":"/api-reference/authentication/mint-session-token"},{"title":"Refresh session token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/token/refresh","href":"/api-reference/authentication/refresh-session-token"},{"title":"List runtime auth providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tools-auth","href":"/api-reference/authentication/list-runtime-auth-providers"}]},{"group":"Users \u0026 Groups","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/users","href":"/api-reference/users-\u0026-groups/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/users","href":"/api-reference/users-\u0026-groups/create-user"},{"title":"Update user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/users/{userId}","href":"/api-reference/users-\u0026-groups/update-user"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/groups","href":"/api-reference/users-\u0026-groups/list-groups"},{"title":"Create group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/groups","href":"/api-reference/users-\u0026-groups/create-group"},{"title":"Update group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/groups/{groupId}","href":"/api-reference/users-\u0026-groups/update-group"}]},{"group":"Organizations","pages":[{"title":"Create organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs","href":"/api-reference/organizations/create-organization"},{"title":"List organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/orgs","href":"/api-reference/organizations/list-organizations"},{"title":"Suspend organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs/{id}/suspend","href":"/api-reference/organizations/suspend-organization"},{"title":"Resume organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/orgs/{id}/resume","href":"/api-reference/organizations/resume-organization"}]},{"group":"Billing","pages":[{"title":"Get credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/balance","href":"/api-reference/billing/get-credit-balance"},{"title":"List credit transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/transactions","href":"/api-reference/billing/list-credit-transactions"},{"title":"List usage invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/billing/invoices","href":"/api-reference/billing/list-usage-invoices"}]},{"group":"Chat \u0026 Messaging","pages":[{"title":"Stream chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/chat","href":"/api-reference/chat/stream-chat"},{"title":"Run agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/run","href":"/api-reference/chat/run-agent"},{"title":"Run network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/run","href":"/api-reference/chat/run-network"},{"title":"Resume stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/chat/stream","href":"/api-reference/chat/resume-stream"},{"title":"Cancel stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/chat/stream","href":"/api-reference/chat/cancel-stream"},{"title":"List threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/threads","href":"/api-reference/chat/list-threads"},{"title":"List messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/messages","href":"/api-reference/chat/list-messages"},{"title":"Vote on message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/vote","href":"/api-reference/chat/vote-on-message"},{"title":"Mark thread read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/threads/{id}/read","href":"/api-reference/chat/mark-thread-read"},{"title":"Append thread messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/threads/{id}/messages","href":"/api-reference/chat/append-thread-messages"},{"title":"Delete thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/threads/{id}","href":"/api-reference/chat/delete-thread"},{"title":"Transcribe audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/audio/transcriptions","href":"/api-reference/chat/transcribe-audio"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Save agent draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/agents/{id}/draft","href":"/api-reference/agents/save-agent-draft"},{"title":"Preview agent prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/instructions/preview","href":"/api-reference/agents/preview-agent-prompt"},{"title":"Publish agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/publish","href":"/api-reference/agents/publish-agent"},{"title":"Activate agent version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/agents/{id}/activate","href":"/api-reference/agents/activate-agent-version"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/agents/{id}/versions","href":"/api-reference/agents/list-agent-versions"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/agents/{id}","href":"/api-reference/agents/delete-agent"}]},{"group":"Prompt Blocks","pages":[{"title":"List prompt blocks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks","href":"/api-reference/prompt-blocks/list-prompt-blocks"},{"title":"Create prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks","href":"/api-reference/prompt-blocks/create-prompt-block"},{"title":"Get prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}","href":"/api-reference/prompt-blocks/get-prompt-block"},{"title":"Save block draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/prompt-blocks/{id}/draft","href":"/api-reference/prompt-blocks/save-block-draft"},{"title":"Publish prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/publish","href":"/api-reference/prompt-blocks/publish-prompt-block"},{"title":"Activate block version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/activate","href":"/api-reference/prompt-blocks/activate-block-version"},{"title":"List block versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}/versions","href":"/api-reference/prompt-blocks/list-block-versions"},{"title":"List block references","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/prompt-blocks/{id}/references","href":"/api-reference/prompt-blocks/list-block-references"},{"title":"Roll out block version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/{id}/rollout","href":"/api-reference/prompt-blocks/roll-out-block-version"},{"title":"Preview block content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/prompt-blocks/preview","href":"/api-reference/prompt-blocks/preview-block-content"},{"title":"Delete prompt block","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/prompt-blocks/{id}","href":"/api-reference/prompt-blocks/delete-prompt-block"}]},{"group":"Skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills","href":"/api-reference/skills/list-skills"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills","href":"/api-reference/skills/create-skill"},{"title":"Get skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}","href":"/api-reference/skills/get-skill"},{"title":"Save skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/skills/{id}","href":"/api-reference/skills/save-skill"},{"title":"Publish skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills/{id}/publish","href":"/api-reference/skills/publish-skill"},{"title":"Activate skill version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/skills/{id}/activate","href":"/api-reference/skills/activate-skill-version"},{"title":"List skill versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}/versions","href":"/api-reference/skills/list-skill-versions"},{"title":"List skill references","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/skills/{id}/references","href":"/api-reference/skills/list-skill-references"},{"title":"Delete skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/skills/{id}","href":"/api-reference/skills/delete-skill"}]},{"group":"Workflows","pages":[{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Create workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows","href":"/api-reference/workflows/create-workflow"},{"title":"Get workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/{id}","href":"/api-reference/workflows/get-workflow"},{"title":"Save workflow draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workflows/{id}/draft","href":"/api-reference/workflows/save-workflow-draft"},{"title":"Publish workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/publish","href":"/api-reference/workflows/publish-workflow"},{"title":"Activate workflow version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/activate","href":"/api-reference/workflows/activate-workflow-version"},{"title":"List workflow versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/{id}/versions","href":"/api-reference/workflows/list-workflow-versions"},{"title":"Run workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflows/{id}/run","href":"/api-reference/workflows/run-workflow"},{"title":"Get workflow schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflows/definition-schema","href":"/api-reference/workflows/get-workflow-schema"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workflows/{id}","href":"/api-reference/workflows/delete-workflow"}]},{"group":"Approvals","pages":[{"title":"List my approval requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/approval-requests","href":"/api-reference/approvals/list-my-approval-requests"},{"title":"Get approval request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/approval-requests/{ref}","href":"/api-reference/approvals/get-approval-request"},{"title":"Decide approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/approval-requests/{ref}/decide","href":"/api-reference/approvals/decide-approval"}]},{"group":"Workflow Schedules","pages":[{"title":"List workflow schedules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules","href":"/api-reference/workflows/list-workflow-schedules"},{"title":"Create workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules","href":"/api-reference/workflows/create-workflow-schedule"},{"title":"Preview schedule timing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/preview","href":"/api-reference/workflows/preview-schedule-timing"},{"title":"Get workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/{id}","href":"/api-reference/workflows/get-workflow-schedule"},{"title":"Update workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/workflow-schedules/{id}","href":"/api-reference/workflows/update-workflow-schedule"},{"title":"Delete workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/workflow-schedules/{id}","href":"/api-reference/workflows/delete-workflow-schedule"},{"title":"Pause workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/pause","href":"/api-reference/workflows/pause-workflow-schedule"},{"title":"Resume workflow schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/resume","href":"/api-reference/workflows/resume-workflow-schedule"},{"title":"Run workflow schedule now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/workflow-schedules/{id}/run-now","href":"/api-reference/workflows/run-workflow-schedule-now"},{"title":"List schedule runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-schedules/{id}/runs","href":"/api-reference/workflows/list-schedule-runs"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-runs","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Get workflow run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/workflow-runs/{id}","href":"/api-reference/workflows/get-workflow-run"}]},{"group":"Dashboards","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards","href":"/api-reference/dashboards/list-dashboards"},{"title":"Create dashboard from spec","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards","href":"/api-reference/dashboards/create-dashboard-from-spec"},{"title":"List dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/templates","href":"/api-reference/dashboards/list-dashboard-templates"},{"title":"Get dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}","href":"/api-reference/dashboards/get-dashboard"},{"title":"Refresh dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/refresh","href":"/api-reference/dashboards/refresh-dashboard"},{"title":"Get dashboard refresh","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}/runs/{runId}","href":"/api-reference/dashboards/get-dashboard-refresh"},{"title":"Run dashboard view","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/views/{viewId}/run","href":"/api-reference/dashboards/run-dashboard-view"},{"title":"List dashboard versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboards/{id}/versions","href":"/api-reference/dashboards/list-dashboard-versions"},{"title":"Activate dashboard version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboards/{id}/activate","href":"/api-reference/dashboards/activate-dashboard-version"},{"title":"Rename dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/dashboards/{id}","href":"/api-reference/dashboards/rename-dashboard"},{"title":"Delete dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/dashboards/{id}","href":"/api-reference/dashboards/delete-dashboard"}]},{"group":"Dashboard templates","pages":[{"title":"List stored dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates","href":"/api-reference/dashboard-templates/list-stored-dashboard-templates"},{"title":"Get dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/get-dashboard-template"},{"title":"Save dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/save-dashboard-template"},{"title":"Update dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/update-dashboard-template"},{"title":"Delete dashboard template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/dashboard-templates/{key}","href":"/api-reference/dashboard-templates/delete-dashboard-template"},{"title":"Publish dashboard templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/dashboard-templates/publish","href":"/api-reference/dashboard-templates/publish-dashboard-templates"},{"title":"Get dashboard template publish state","description":"What a publisher diffs against before `POST /v1/dashboard-templates/publish`: the hash of every published (`source: repo`) template of one collection of this organization, the keys in picker order, and the last publish. With the platform key, the shared set.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/dashboard-templates/state","href":"/api-reference/dashboard-templates/get-dashboard-template-publish-state"}]},{"group":"Browser","pages":[{"title":"Open a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions","href":"/api-reference/browser/open-a-browser-session"},{"title":"List browser sessions","description":"The browser sessions the caller may see, **oldest update first**, so a caller that keeps its own record pulls with `updated_since` set to the newest `updated_at` it has and gets every session that changed since — the ones that ended included. An API key lists the organization's sessions; a session token its own user's.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions","href":"/api-reference/browser/list-browser-sessions"},{"title":"Get a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}","href":"/api-reference/browser/get-a-browser-session"},{"title":"Get the live view of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/live-view","href":"/api-reference/browser/get-the-live-view-of-a-browser-session"},{"title":"Get a still of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/still","href":"/api-reference/browser/get-a-still-of-a-browser-session"},{"title":"Get the replay of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/replay","href":"/api-reference/browser/get-the-replay-of-a-browser-session"},{"title":"Get one page of a replay","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/browser-sessions/{id}/replay/{page}","href":"/api-reference/browser/get-one-page-of-a-replay"},{"title":"Open a tab","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/tabs","href":"/api-reference/browser/open-a-tab"},{"title":"Close a tab","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/browser-sessions/{id}/tabs/{index}","href":"/api-reference/browser/close-a-tab"},{"title":"Take over a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/take-over","href":"/api-reference/browser/take-over-a-browser-session"},{"title":"Hand a browser session back to the agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/hand-back","href":"/api-reference/browser/hand-a-browser-session-back-to-the-agent"},{"title":"Pause the agent in a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/pause","href":"/api-reference/browser/pause-the-agent-in-a-browser-session"},{"title":"Resume the agent in a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/resume","href":"/api-reference/browser/resume-the-agent-in-a-browser-session"},{"title":"Stop a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/stop","href":"/api-reference/browser/stop-a-browser-session"},{"title":"Hand a browser session to an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/attach","href":"/api-reference/browser/hand-a-browser-session-to-an-agent"},{"title":"Keep the sign-in of a browser session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/browser-sessions/{id}/keep-sign-in","href":"/api-reference/browser/keep-the-sign-in-of-a-browser-session"},{"title":"Delete a saved login","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/browser-saved-logins/{ref}","href":"/api-reference/browser/delete-a-saved-login"}]},{"group":"Networks","pages":[{"title":"List networks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/networks","href":"/api-reference/networks/list-networks"},{"title":"Create network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/networks","href":"/api-reference/networks/create-network"},{"title":"Get network copilots","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/networks/{id}","href":"/api-reference/networks/get-network-copilots"},{"title":"Rename network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/networks/{id}","href":"/api-reference/networks/rename-network"},{"title":"Get network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/copilots/{id}","href":"/api-reference/networks/get-network"},{"title":"Update network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/copilots/{id}","href":"/api-reference/networks/update-network"},{"title":"Attach agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/agents","href":"/api-reference/networks/attach-agent"},{"title":"Detach agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/copilots/{id}/agents/{agentId}","href":"/api-reference/networks/detach-agent"},{"title":"Attach workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/workflows","href":"/api-reference/networks/attach-workflow"},{"title":"Detach workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/copilots/{id}/workflows/{workflowId}","href":"/api-reference/networks/detach-workflow"},{"title":"Deploy network","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/copilots/{id}/deploy","href":"/api-reference/networks/deploy-network"}]},{"group":"Tools","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tools","href":"/api-reference/tools/list-tools"},{"title":"Execute tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tools/{toolId}/execute","href":"/api-reference/tools/execute-tool"},{"title":"Create tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tools","href":"/api-reference/tools/create-tool"},{"title":"Update tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tools/{id}","href":"/api-reference/tools/update-tool"},{"title":"Delete tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tools/{id}","href":"/api-reference/tools/delete-tool"}]},{"group":"Tool Providers","pages":[{"title":"List tool providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tool-providers","href":"/api-reference/tool-providers/list-tool-providers"},{"title":"Create tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tool-providers","href":"/api-reference/tool-providers/create-tool-provider"},{"title":"Get tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/tool-providers/{id}","href":"/api-reference/tool-providers/get-tool-provider"},{"title":"Update tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tool-providers/{id}","href":"/api-reference/tool-providers/update-tool-provider"},{"title":"Save provider tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/tool-providers/{id}/tools","href":"/api-reference/tool-providers/save-provider-tools"},{"title":"Delete tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tool-providers/{id}","href":"/api-reference/tool-providers/delete-tool-provider"},{"title":"Grant tool provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/tool-providers/{id}/grants","href":"/api-reference/tool-providers/grant-tool-provider"},{"title":"Revoke tool provider grant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/tool-providers/{id}/grants/{org_id}","href":"/api-reference/tool-providers/revoke-tool-provider-grant"}]},{"group":"Datasets","pages":[{"title":"List datasets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets","href":"/api-reference/datasets/list-datasets"},{"title":"Create dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets","href":"/api-reference/datasets/create-dataset"},{"title":"Get dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}","href":"/api-reference/datasets/get-dataset"},{"title":"Update dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/datasets/{id}","href":"/api-reference/datasets/update-dataset"},{"title":"Delete dataset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/datasets/{id}","href":"/api-reference/datasets/delete-dataset"},{"title":"List dataset items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}/items","href":"/api-reference/datasets/list-dataset-items"},{"title":"Add dataset items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets/{id}/items","href":"/api-reference/datasets/add-dataset-items"},{"title":"Update dataset item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/datasets/{id}/items/{itemId}","href":"/api-reference/datasets/update-dataset-item"},{"title":"Delete dataset item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/datasets/{id}/items/{itemId}","href":"/api-reference/datasets/delete-dataset-item"}]},{"group":"Scoring \u0026 Experiments","pages":[{"title":"Run experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/experiments","href":"/api-reference/experiments/run-experiment"},{"title":"Get experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/experiments/{experimentId}","href":"/api-reference/experiments/get-experiment"},{"title":"Delete experiment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/experiments/{experimentId}","href":"/api-reference/experiments/delete-experiment"},{"title":"List experiments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/datasets/{id}/experiments","href":"/api-reference/experiments/list-experiments"},{"title":"Compare experiments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/datasets/{id}/compare","href":"/api-reference/experiments/compare-experiments"},{"title":"Score traces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/score-trace","href":"/api-reference/experiments/score-traces"},{"title":"List trace scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/traces/{traceId}/scores","href":"/api-reference/experiments/list-trace-scores"}]},{"group":"Observability","pages":[{"title":"List requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests","href":"/api-reference/observability/list-requests"},{"title":"Get a request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/{id}","href":"/api-reference/observability/get-a-request"},{"title":"Request statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/stats","href":"/api-reference/observability/request-statistics"},{"title":"Request filter options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/requests/filters","href":"/api-reference/observability/request-filter-options"}]},{"group":"System","pages":[{"title":"Rebuild agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/rebuild","href":"/api-reference/system/rebuild-agents"},{"title":"Rebuild org tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rebuild-org-tools","href":"/api-reference/system/rebuild-org-tools"}]}]},{"tab":"Chat SDK","pages":[{"title":"Chat SDK","href":"/sdk/overview"}]}]},"basePath":"","title":"Open a browser session - Sidenet API","buildId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","deploymentId":"dpl_6PxPD4Fj1JDU9BJxEHvfdUmxKThw","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CASS2Vpq.js","utils-4k9fyWRu.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-UU-UueZb.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BgJ0LOYq.js","snippetPresets-CMgzlMR-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BzEJegkK.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CZuQIZdk.js","shallow-Bw5arfMA.js","getApiPlaygroundDisplay-Ds834aVN.js","CodeSnippet-CKzmjw9L.js","CodeSnippets-BRpgomdp.js","Page-DvEUoD2H.js","getPastedJson-B0N-Tn76.js","icon-DASMs9nC.js","MethodPill-BA6DBLqx.js","DuplicateIcon-BMT5qfbJ.js","createIcon-CNfwVWPx.js","DynamicMarkdown-JYyBNlrJ.js","SectionHeading-BbZnmz8a.js","axios-vUo_bRtp.js","Markdown-LUU0YLpA.js","clsx-Di4ek5Ae.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-VEVWQCR4.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CPszyu99.js"]}