Use OpenHands with the Toad universal terminal interface for AI agents
The OpenHands CLI is no longer actively maintained. These instructions are retained for legacy users.
For a maintained local installation, use Agent Canvas with npm, npx, or Docker.
Toad is a universal terminal interface for AI agents, created by Will McGugan, the creator of the popular Python libraries Rich and Textual.The name comes from “textual code”—combining the Textual framework with coding assistance.
Toad provides a modern terminal user experience that addresses several limitations common to existing terminal-based AI tools:
No flickering or visual artifacts - Toad can update partial regions of the screen without redrawing everything
Scrollback that works - You can scroll back through your conversation history and interact with previous outputs
A unified experience - Instead of learning different interfaces for different AI agents, Toad provides a consistent experience across all supported agents through ACP
OpenHands is included as a recommended agent in Toad’s agent store.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpenHands Docs","colors":{"primary":"#99873c","light":"#ffe165","dark":"#ffe165"},"logo":{"light":"https://mintcdn.com/allhandsai/DjhqLcIy_hW6pRTg/logo/light.png?fit=max\u0026auto=format\u0026n=DjhqLcIy_hW6pRTg\u0026q=85\u0026s=49b636402b03f7279ca5e1afefeec1d2","dark":"https://mintcdn.com/allhandsai/DjhqLcIy_hW6pRTg/logo/dark.png?fit=max\u0026auto=format\u0026n=DjhqLcIy_hW6pRTg\u0026q=85\u0026s=e0c4017631cebc3a289798438e2c0d7a"},"favicon":"https://mintcdn.com/allhandsai/DjhqLcIy_hW6pRTg/openhands/logo-square.png?fit=max\u0026auto=format\u0026n=DjhqLcIy_hW6pRTg\u0026q=85\u0026s=6ef1bab575660ae6e2d44fcc57bc675f","appearance":{"default":"light"},"background":{"color":{"light":"#f7f3ee","dark":"#0B0D0E"}},"navbar":{"links":[],"primary":{"type":"github","href":"https://github.com/OpenHands/OpenHands"}},"footer":{"socials":{"slack":"https://openhands.dev/joinslack","github":"https://github.com/OpenHands"},"links":[{"header":"Links","items":[{"label":"Company","href":"https://openhands.dev/"},{"label":"Blog","href":"https://openhands.dev/blog"},{"label":"Cloud","href":"https://app.all-hands.dev"},{"label":"Enterprise","href":"https://openhands.dev/enterprise"}]}]},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","download-spec","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"allhandsai","hasAudioNarration":false,"actualSubdomain":"allhandsai","customDomains":["docs.openhands.dev"],"gitSource":{"type":"github","owner":"openhands","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec959dccb20a4aa1bb8b5d","collectionId":"aebf9ab2-8684-4bf0-a9b9-399389287dd8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec959dccb20a4aa1bb8b5d"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecf5feb48f80803ba84ea8","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"Cloud","count":196},{"language":"default","tag":"Cloud API","count":187},{"language":"default","tag":"REST API Reference","count":185},{"language":"default","tag":"SDK","count":127},{"language":"default","tag":"Guides","count":104},{"language":"default","tag":"API Reference","count":95},{"language":"default","tag":"Enterprise","count":68},{"language":"default","tag":"Agent Canvas","count":60},{"language":"default","tag":"Home","count":58},{"language":"default","tag":"Remote Agent Server","count":55}]},"assistantConfig":{"deflection":{"enabled":true,"email":"contact@openhands.dev","showHelpButton":true}},"basePath":"","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#banner *{color:rgb(67, 66, 64)}"}],"page":{"pagePath":"openhands/usage/cli/ide/toad","slug":"/openhands/usage/cli/ide/toad","pageMetadata":{"title":"Toad Terminal","description":"Use OpenHands with the Toad universal terminal interface for AI agents","href":"/openhands/usage/cli/ide/toad"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Use OpenHands with the Toad universal terminal interface for AI agents\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,img:`img`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The OpenHands CLI is no longer actively maintained.`}),` These instructions are retained for legacy users.\nFor a maintained local installation, use `,_jsx(_components.a,{href:`/openhands/usage/agent-canvas/setup#install-and-run`,children:`Agent Canvas with npm, npx, or Docker`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`https://github.com/Textualize/toad`,children:`Toad`}),` is a universal terminal interface for AI agents, created by `,_jsx(_components.a,{href:`https://willmcgugan.github.io/`,children:`Will McGugan`}),`, the creator of the popular Python libraries `,_jsx(_components.a,{href:`https://github.com/Textualize/rich`,children:`Rich`}),` and `,_jsx(_components.a,{href:`https://github.com/Textualize/textual`,children:`Textual`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The name comes from “`,_jsx(_components.strong,{children:`t`}),`extual c`,_jsx(_components.strong,{children:`ode`}),`”—combining the Textual framework with coding assistance.`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.img,{src:`https://willmcgugan.github.io/images/toad-released/toad-1.png`,alt:`Toad Terminal Interface`})}),`\n`,_jsx(Heading,{level:`2`,id:`why-toad`,children:`Why Toad?`}),`\n`,_jsx(_components.p,{children:`Toad provides a modern terminal user experience that addresses several limitations common to existing terminal-based AI tools:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`No flickering or visual artifacts`}),` - Toad can update partial regions of the screen without redrawing everything`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Scrollback that works`}),` - You can scroll back through your conversation history and interact with previous outputs`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`A unified experience`}),` - Instead of learning different interfaces for different AI agents, Toad provides a consistent experience across all supported agents through ACP`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`OpenHands is included as a recommended agent in Toad’s agent store.`}),`\n`,_jsx(Heading,{level:`2`,id:`prerequisites`,children:`Prerequisites`}),`\n`,_jsx(_components.p,{children:`Before using Toad with OpenHands:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`OpenHands CLI installed`}),` - See `,_jsx(_components.a,{href:`/openhands/usage/cli/installation`,children:`Installation`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`LLM settings configured`}),` - Run `,_jsx(_components.code,{children:`openhands`}),` and use `,_jsx(_components.code,{children:`/settings`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsxs(_components.p,{children:[`Install Toad using `,_jsx(_components.a,{href:`https://docs.astral.sh/uv/`,children:`uv`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uvx`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` batrachian-toad`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`For more installation options and documentation, visit `,_jsx(_components.a,{href:`https://www.batrachian.ai/`,children:`batrachian.ai`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`setup`,children:`Setup`}),`\n`,_jsx(Heading,{level:`3`,id:`using-the-agent-store`,children:`Using the Agent Store`}),`\n`,_jsx(_components.p,{children:`The easiest way to set up OpenHands with Toad:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Launch Toad: `,_jsx(_components.code,{children:`uvx batrachian-toad`})]}),`\n`,_jsx(_components.li,{children:`Open Toad’s agent store`}),`\n`,_jsxs(_components.li,{children:[`Find `,_jsx(_components.strong,{children:`OpenHands`}),` in the list of recommended agents`]}),`\n`,_jsxs(_components.li,{children:[`Click `,_jsx(_components.strong,{children:`Install`}),` to set up OpenHands`]}),`\n`,_jsx(_components.li,{children:`Select OpenHands and start a conversation`}),`\n`]}),`\n`,_jsx(_components.p,{children:`The install process runs:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` tool`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` openhands`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --python`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3.12`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` \u0026\u0026 `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`openhands`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` login`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`manual-configuration`,children:`Manual Configuration`}),`\n`,_jsx(_components.p,{children:`You can also launch Toad directly with OpenHands:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`usage`,children:`Usage`}),`\n`,_jsx(Heading,{level:`3`,id:`basic-usage`,children:`Basic Usage`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Launch Toad with OpenHands`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`with-command-line-arguments`,children:`With Command Line Arguments`}),`\n`,_jsx(_components.p,{children:`Pass OpenHands CLI flags through Toad:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Use LLM-based approval mode`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp --llm-approve\"`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Auto-approve all actions`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp --always-approve\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`resume-a-conversation`,children:`Resume a Conversation`}),`\n`,_jsx(_components.p,{children:`Resume a specific conversation by ID:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp --resume abc123def456\"`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Resume the most recent conversation:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp --resume --last\"`})]}),`\n`]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Find your conversation IDs by running `,_jsx(_components.code,{children:`openhands --resume`}),` in a regular terminal.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`advanced-configuration`,children:`Advanced Configuration`}),`\n`,_jsx(Heading,{level:`3`,id:`combined-options`,children:`Combined Options`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Resume with LLM approval`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp --resume --last --llm-approve\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`environment-variables`,children:`Environment Variables`}),`\n`,_jsx(_components.p,{children:`Pass environment variables to OpenHands:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`LLM_API_KEY`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`your-key`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:` toad`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` acp`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"openhands acp\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`troubleshooting`,children:`Troubleshooting`}),`\n`,_jsx(Heading,{level:`3`,id:`”openhands”-command-not-found`,children:`”openhands” command not found`}),`\n`,_jsx(_components.p,{children:`Ensure OpenHands is installed:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` tool`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` openhands`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --python`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 3.12`})]}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Verify it’s in your PATH:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`which`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` openhands`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`agent-doesn’t-respond`,children:`Agent doesn’t respond`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Check your LLM settings: `,_jsx(_components.code,{children:`openhands`}),` then `,_jsx(_components.code,{children:`/settings`})]}),`\n`,_jsx(_components.li,{children:`Verify your API key is valid`}),`\n`,_jsx(_components.li,{children:`Check network connectivity to your LLM provider`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`conversation-not-persisting`,children:`Conversation not persisting`}),`\n`,_jsxs(_components.p,{children:[`Conversations are stored in `,_jsx(_components.code,{children:`~/.openhands/conversations`}),`. Ensure this directory exists and is writable.`]}),`\n`,_jsx(Heading,{level:`2`,id:`see-also`,children:`See Also`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/openhands/usage/cli/ide/overview`,children:`IDE Integration Overview`}),` - ACP concepts and other IDEs`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://www.batrachian.ai/`,children:`Toad Documentation`}),` - Official Toad documentation`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/openhands/usage/cli/terminal`,children:`Terminal Mode`}),` - Use OpenHands directly in terminal`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/openhands/usage/cli/resume`,children:`Resume Conversations`}),` - Find conversation IDs`]}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Toad Terminal","description":"Use OpenHands with the Toad universal terminal interface for AI agents","href":"/openhands/usage/cli/ide/toad"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Why Toad?","slug":"why-toad","depth":2,"children":[]},{"title":"Prerequisites","slug":"prerequisites","depth":2,"children":[]},{"title":"Installation","slug":"installation","depth":2,"children":[]},{"title":"Setup","slug":"setup","depth":2,"children":[{"title":"Using the Agent Store","slug":"using-the-agent-store","depth":3,"children":[]},{"title":"Manual Configuration","slug":"manual-configuration","depth":3,"children":[]}]},{"title":"Usage","slug":"usage","depth":2,"children":[{"title":"Basic Usage","slug":"basic-usage","depth":3,"children":[]},{"title":"With Command Line Arguments","slug":"with-command-line-arguments","depth":3,"children":[]},{"title":"Resume a Conversation","slug":"resume-a-conversation","depth":3,"children":[]}]},{"title":"Advanced Configuration","slug":"advanced-configuration","depth":2,"children":[{"title":"Combined Options","slug":"combined-options","depth":3,"children":[]},{"title":"Environment Variables","slug":"environment-variables","depth":3,"children":[]}]},{"title":"Troubleshooting","slug":"troubleshooting","depth":2,"children":[{"title":"”openhands” command not found","slug":"”openhands”-command-not-found","depth":3,"children":[]},{"title":"Agent doesn’t respond","slug":"agent-doesn’t-respond","depth":3,"children":[]},{"title":"Conversation not persisting","slug":"conversation-not-persisting","depth":3,"children":[]}]},{"title":"See Also","slug":"see-also","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/allhandsai/dddab338317a519d/openhands/reo-init.js","/_mintlify/custom/allhandsai/ae719f15d762e1fe/openhands/posthog-init.js","/_mintlify/custom/allhandsai/b35f7f3c3c83fb4c/openhands/canvas-handoff.js","/_mintlify/custom/allhandsai/771d6371c43b73b7/openhands/linkedin-copy-tracking.js"],"subdomain":"allhandsai","siteName":"OpenHands Docs","title":"Toad Terminal - OpenHands Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T14:00:23.879Z","originalFileLocation":"openhands/usage/cli/ide/toad.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=\"light\"}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=\"Use OpenHands with the Toad universal terminal interface for AI agents\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpenHands Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_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=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Toad Terminal - OpenHands Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use OpenHands with the Toad universal terminal interface for AI agents\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpenHands Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openhands.dev/openhands/usage/cli/ide/toad\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://allhandsai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Toad+Terminal\u0026amp;description=Use+OpenHands+with+the+Toad+universal+terminal+interface+for+AI+agents\u0026amp;theme=d1346828d5653c6c432bc1fc\u0026amp;signature=bcda6374c66ab1cb0af01dc5ad5fad3a4a9c2349d292ec16a402c279c07c3dbf\">\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=\"Toad Terminal - OpenHands Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use OpenHands with the Toad universal terminal interface for AI agents\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://allhandsai.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Toad+Terminal\u0026amp;description=Use+OpenHands+with+the+Toad+universal+terminal+interface+for+AI+agents\u0026amp;theme=d1346828d5653c6c432bc1fc\u0026amp;signature=bcda6374c66ab1cb0af01dc5ad5fad3a4a9c2349d292ec16a402c279c07c3dbf\">\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=\"/mintlify-assets/_mintlify/favicons/allhandsai/NJyVpY-OoVetrcKF/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpenHands Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#99873c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openhands.dev/openhands/usage/cli/ide/toad\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/openhands/usage/cli/ide/toad.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpenHands Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpenHands Docs","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/overview/introduction"},{"title":"Quick Start","href":"/overview/quickstart"},{"title":"Tutorial Library","href":"/openhands/usage/get-started/tutorials"}]},{"group":"Essential Guidelines","pages":[{"title":"When to Use OpenHands","href":"/openhands/usage/essential-guidelines/when-to-use-openhands"},{"title":"Prompting Best Practices","href":"/openhands/usage/tips/prompting-best-practices"},{"title":"Good vs. Bad Instructions","href":"/openhands/usage/essential-guidelines/good-vs-bad-instructions"},{"title":"OpenHands in Your SDLC","href":"/openhands/usage/essential-guidelines/sdlc-integration"}]},{"group":"Use Cases","pages":[{"title":"Use Cases Overview","href":"/openhands/usage/use-cases/overview"},{"title":"Vulnerability Remediation","href":"/openhands/usage/use-cases/vulnerability-remediation"},{"title":"Automated Code Review","href":"/openhands/usage/use-cases/code-review"},{"title":"Automated QA Testing","href":"/openhands/usage/use-cases/qa-changes"},{"title":"Incident Triage","href":"/openhands/usage/use-cases/incident-triage"},{"title":"COBOL Modernization","href":"/openhands/usage/use-cases/cobol-modernization"},{"title":"Dependency Upgrades","href":"/openhands/usage/use-cases/dependency-upgrades"},{"title":"Agent-Driven Daily Workflow","href":"/openhands/usage/use-cases/daily-workflow"},{"title":"Software Factory","href":"/openhands/usage/use-cases/software-factory"},{"title":"Spark Migrations","href":"/openhands/usage/use-cases/spark-migrations"}]},{"group":"Product Guides","pages":[{"title":"Key Features","href":"/openhands/usage/key-features"},{"title":"Hooks","href":"/openhands/usage/customization/hooks"},{"title":"Model Context Protocol (MCP)","href":"/overview/model-context-protocol"},{"group":"Skills","pages":[{"title":"Skills Overview","href":"/overview/skills"},{"title":"General Skills","href":"/overview/skills/repo"},{"title":"Keyword-Triggered Skills","href":"/overview/skills/keyword"},{"title":"Path-Triggered Rules","href":"/overview/skills/path"},{"title":"Organization and User Skills","href":"/overview/skills/org"},{"title":"Global Skills","href":"/overview/skills/public"},{"title":"Adding New Skills","href":"/overview/skills/adding"},{"title":"Creating New Skills","href":"/overview/skills/creating"},{"title":"Monitoring and Improving Skills","href":"/overview/skills/monitoring"}]},{"title":"Plugins","href":"/overview/plugins"},{"title":"Agent Plugins Packages","href":"/overview/agent-plugins"},{"group":"Automations","pages":[{"title":"Automations Overview","href":"/openhands/usage/automations/overview"},{"title":"Creating Automations","href":"/openhands/usage/automations/creating-automations"},{"title":"Event-Based Automations","href":"/openhands/usage/automations/event-automations"},{"title":"Managing Automations","href":"/openhands/usage/automations/managing-automations"}]},{"title":"Repository Customization","href":"/openhands/usage/customization/repository"},{"group":"Settings","pages":[{"title":"Application Settings","href":"/openhands/usage/settings/application-settings"},{"title":"Language Model (LLM) Settings","href":"/openhands/usage/settings/llm-settings"},{"title":"Secrets Management","href":"/openhands/usage/settings/secrets-settings"},{"title":"Model Context Protocol (MCP)","href":"/openhands/usage/settings/mcp-settings"}]}]},{"group":"Additional Documentation","pages":[{"group":"Sandbox Server","pages":[{"title":"REST API (V1)","href":"/openhands/usage/api/v1"}]},{"group":"LLM Configuration","pages":[{"title":"Overview","href":"/openhands/usage/llms/llms"},{"group":"LLM Providers","pages":[{"title":"OpenHands","href":"/openhands/usage/llms/openhands-llms"},{"title":"AWS Bedrock","href":"/openhands/usage/llms/aws-bedrock"},{"title":"Azure","href":"/openhands/usage/llms/azure-llms"},{"title":"Use DigitalOcean Inference with OpenHands","href":"/openhands/usage/llms/digitalocean"},{"title":"Google Gemini/Vertex","href":"/openhands/usage/llms/google-llms"},{"title":"Groq","href":"/openhands/usage/llms/groq"},{"title":"Run Local LLMs with OpenHands","href":"/openhands/usage/llms/local-llms"},{"title":"LiteLLM Proxy","href":"/openhands/usage/llms/litellm-proxy"},{"title":"Moonshot AI","href":"/openhands/usage/llms/moonshot"},{"title":"OpenAI","href":"/openhands/usage/llms/openai-llms"},{"title":"Use OpenRouter with OpenHands","href":"/openhands/usage/llms/openrouter"}]}]}]},{"group":"OpenHands Community","pages":[{"title":"Community","href":"/overview/community"},{"title":"Contributing","href":"/overview/contributing"},{"title":"Issue Triage and the ready-for-dev Gate","href":"/overview/issue-lifecycle"},{"title":"FAQs","href":"/overview/faqs"},{"title":null,"href":"/openhands/usage/troubleshooting/feedback"}]}]},{"tab":"Agent Canvas","pages":[{"title":"Agent Canvas Overview","href":"/openhands/usage/agent-canvas/overview"},{"title":"Agent Canvas Architecture","href":"/openhands/usage/agent-canvas/architecture"},{"group":"Install Canvas","pages":[{"title":"Install Agent Canvas","href":"/openhands/usage/agent-canvas/setup"},{"title":"First Time Setup","href":"/openhands/usage/agent-canvas/first-time-setup"}]},{"group":"Automations","pages":[{"title":"Managing automations","href":"/openhands/usage/agent-canvas/managing-automations"},{"title":"Event Sources","href":"/openhands/usage/agent-canvas/automation-events"},{"title":"Sync Automations with Git","href":"/openhands/usage/agent-canvas/git-sync"},{"title":"Setup a Pre-built Automation","href":"/openhands/usage/agent-canvas/prebuilt-automations"},{"title":"Issue to Pull Request Automation","href":"/openhands/usage/agent-canvas/prebuilt/issue-to-pr"},{"title":"GitHub PR Review Assistant","href":"/openhands/usage/agent-canvas/prebuilt/github-pr-review"},{"title":"GitHub Repository Monitor","href":"/openhands/usage/agent-canvas/prebuilt/github-repo-monitor"},{"title":"Slack Channel Monitor","href":"/openhands/usage/agent-canvas/prebuilt/slack-channel-monitor"}]},{"group":"Use Canvas","pages":[{"title":"Conversations","href":"/openhands/usage/agent-canvas/conversations"},{"title":"Agent Profiles","href":"/openhands/usage/agent-canvas/agent-profiles"},{"title":"Manage LLM Profiles","href":"/openhands/usage/agent-canvas/llm-profiles"},{"title":"Configure a Model","href":"/openhands/usage/agent-canvas/model-configuration"},{"title":"ACP Agents","href":"/openhands/usage/agent-canvas/acp-agents"},{"title":"Plugins in Agent Canvas","href":"/openhands/usage/agent-canvas/plugins"},{"title":"Apps (Beta)","href":"/openhands/usage/agent-canvas/canvas-extensions"},{"title":"Critic","href":"/openhands/usage/agent-canvas/critic"},{"title":"Customize and Settings","href":"/openhands/usage/agent-canvas/customize-and-settings"},{"title":"Phone \u0026 Tablet Access","href":"/openhands/usage/agent-canvas/mobile-access"}]},{"group":"Connect Backends","pages":[{"title":"Backends","href":"/openhands/usage/agent-canvas/backends"},{"title":"Local Backend","href":"/openhands/usage/agent-canvas/backend-setup/local"},{"title":"Remote Backend","href":"/openhands/usage/agent-canvas/backend-setup/remote"},{"title":"Cloud Backend","href":"/openhands/usage/agent-canvas/backend-setup/cloud"},{"title":"DigitalOcean Managed Agents","href":"/openhands/usage/agent-canvas/backend-setup/digitalocean"}]},{"group":"Self-Host Backend Services","pages":[{"title":"VM / Self-Hosted Installation","href":"/openhands/usage/agent-canvas/backend-setup/vm"},{"title":"Use Docker with Agent Canvas","href":"/openhands/usage/agent-canvas/backend-setup/docker"},{"title":"Run Each Conversation in Its Own Docker Container","href":"/openhands/usage/agent-canvas/backend-setup/docker-execution"},{"title":"Kubernetes (Helm)","href":"/openhands/usage/agent-canvas/backend-setup/kubernetes"},{"title":"Modal Backend","href":"/openhands/usage/agent-canvas/backend-setup/modal"}]},{"group":"Contribute And Troubleshoot","pages":[{"title":"Contributing","href":"/openhands/usage/agent-canvas/development"},{"title":"Troubleshooting","href":"/openhands/usage/agent-canvas/troubleshooting"}]},{"group":"Release Notes","pages":[{"title":"Agent Canvas 1.35.0","href":"/openhands/usage/agent-canvas/release-notes/v1.35.0"},{"title":"Agent Canvas 1.34.0","href":"/openhands/usage/agent-canvas/release-notes/v1.34.0"},{"title":"Agent Canvas 1.33.0","href":"/openhands/usage/agent-canvas/release-notes/v1.33.0"},{"title":"Agent Canvas 1.32.0","href":"/openhands/usage/agent-canvas/release-notes/v1.32.0"},{"title":"Agent Canvas 1.31.0","href":"/openhands/usage/agent-canvas/release-notes/v1.31.0"},{"title":"Agent Canvas 1.30.0","href":"/openhands/usage/agent-canvas/release-notes/v1.30.0"},{"title":"Agent Canvas 1.29.0","href":"/openhands/usage/agent-canvas/release-notes/v1.29.0"},{"title":"Agent Canvas 1.28.0","href":"/openhands/usage/agent-canvas/release-notes/v1.28.0"},{"title":"Agent Canvas 1.27.0","href":"/openhands/usage/agent-canvas/release-notes/v1.27.0"},{"title":"Agent Canvas 1.26.0","href":"/openhands/usage/agent-canvas/release-notes/v1.26.0"},{"title":"Agent Canvas 1.25.0","href":"/openhands/usage/agent-canvas/release-notes/v1.25.0"},{"title":"Agent Canvas 1.24.0","href":"/openhands/usage/agent-canvas/release-notes/v1.24.0"},{"title":"Agent Canvas 1.23.0","href":"/openhands/usage/agent-canvas/release-notes/v1.23.0"},{"title":"Agent Canvas 1.22.0","href":"/openhands/usage/agent-canvas/release-notes/v1.22.0"},{"title":"Agent Canvas 1.21.0","href":"/openhands/usage/agent-canvas/release-notes/v1.21.0"},{"title":"Agent Canvas 1.20.0","href":"/openhands/usage/agent-canvas/release-notes/v1.20.0"},{"title":"Agent Canvas 1.19.0","href":"/openhands/usage/agent-canvas/release-notes/v1.19.0"},{"title":"Agent Canvas 1.18.0","href":"/openhands/usage/agent-canvas/release-notes/v1.18.0"},{"title":"Agent Canvas 1.17.0","href":"/openhands/usage/agent-canvas/release-notes/v1.17.0"},{"title":"Agent Canvas 1.16.0","href":"/openhands/usage/agent-canvas/release-notes/v1.16.0"},{"title":"Agent Canvas 1.15.0","href":"/openhands/usage/agent-canvas/release-notes/v1.15.0"},{"title":"Agent Canvas 1.14.0","href":"/openhands/usage/agent-canvas/release-notes/v1.14.0"},{"title":"Agent Canvas 1.13.0","href":"/openhands/usage/agent-canvas/release-notes/v1.13.0"},{"title":"Agent Canvas 1.12.0","href":"/openhands/usage/agent-canvas/release-notes/v1.12.0"},{"title":"Agent Canvas 1.11.0","href":"/openhands/usage/agent-canvas/release-notes/v1.11.0"},{"title":"Agent Canvas 1.10.0","href":"/openhands/usage/agent-canvas/release-notes/v1.10.0"}]}]},{"tab":"SDK","pages":[{"title":"Software Agent SDK","icon":"code","mode":"wide","href":"/sdk"},{"title":"Getting Started","icon":"rocket","href":"/sdk/getting-started"},{"title":"FAQ","icon":"question","href":"/sdk/faq"},{"group":"Guides","pages":[{"title":"Hello World","href":"/sdk/guides/hello-world"},{"title":"Custom Tools","href":"/sdk/guides/custom-tools"},{"title":"Structured Output","href":"/sdk/guides/structured-output"},{"title":"Model Context Protocol","href":"/sdk/guides/mcp"},{"title":"Agent Skills \u0026 Context","href":"/sdk/guides/skill"},{"title":"Plugins","href":"/sdk/guides/plugins"},{"title":"Persistence","href":"/sdk/guides/convo-persistence"},{"title":"Context Condenser","href":"/sdk/guides/context-condenser"},{"title":"Persistent Memory","href":"/sdk/guides/persistent-memory"},{"title":"Agent Settings","href":"/sdk/guides/agent-settings"},{"title":"Parallel Tool Execution","href":"/sdk/guides/parallel-tool-execution"},{"title":"Task Tool Set","href":"/sdk/guides/task-tool-set"},{"title":"Iterative Refinement","href":"/sdk/guides/iterative-refinement"},{"title":"Security \u0026 Action Confirmation","href":"/sdk/guides/security"},{"title":"Metrics Tracking","href":"/sdk/guides/metrics"},{"title":"Observability \u0026 Tracing","href":"/sdk/guides/observability"},{"title":"Secret Registry","href":"/sdk/guides/secrets"},{"group":"LLM Features","pages":[{"title":"LLM Subscriptions","href":"/sdk/guides/llm-subscriptions"},{"title":"LLM Registry","href":"/sdk/guides/llm-registry"},{"title":"Model Routing","href":"/sdk/guides/llm-routing"},{"title":"Reasoning","href":"/sdk/guides/llm-reasoning"},{"title":"GPT-5 Preset (ApplyPatchTool)","href":"/sdk/guides/llm-gpt5-preset"},{"title":"LLM Streaming","href":"/sdk/guides/llm-streaming"},{"title":"Image Input","href":"/sdk/guides/llm-image-input"},{"title":"Exception Handling","href":"/sdk/guides/llm-error-handling"},{"title":"LLM Fallback Strategy","href":"/sdk/guides/llm-fallback"},{"title":"LLM Profile Store","href":"/sdk/guides/llm-profile-store"},{"title":"Task-Based Model Routing","href":"/sdk/guides/llm-task-routing"}]},{"group":"Agent Features","pages":[{"title":"ACP Agent","href":"/sdk/guides/agent-acp"},{"title":"Interactive Terminal","href":"/sdk/guides/agent-interactive-terminal"},{"title":"Browser Use","href":"/sdk/guides/agent-browser-use"},{"title":"Browser Session Recording","href":"/sdk/guides/browser-session-recording"},{"title":"Creating Custom Agent","href":"/sdk/guides/agent-custom"},{"title":"File-Based Agents","href":"/sdk/guides/agent-file-based"},{"title":"Stuck Detector","href":"/sdk/guides/agent-stuck-detector"},{"title":"Ask Oracle","href":"/sdk/guides/agent-ask-oracle"},{"title":"Theory of Mind (TOM) Agent","href":"/sdk/guides/agent-tom-agent"},{"title":"Critic (Experimental)","href":"/sdk/guides/critic"}]},{"group":"Conversation Features","pages":[{"title":"Fork a Conversation","href":"/sdk/guides/convo-fork"},{"title":"Pause and Resume","href":"/sdk/guides/convo-pause-and-resume"},{"title":"Custom Visualizer","href":"/sdk/guides/convo-custom-visualizer"},{"title":"Send Message While Running","href":"/sdk/guides/convo-send-message-while-running"},{"title":"Conversation with Async","href":"/sdk/guides/convo-async"},{"title":"Ask Agent Questions","href":"/sdk/guides/convo-ask-agent"},{"title":"Goal Completion Loop","href":"/sdk/guides/convo-goal"},{"title":"Hooks","href":"/sdk/guides/hooks"}]},{"group":"Remote Agent Server","pages":[{"title":"Overview","href":"/sdk/guides/agent-server/overview"},{"title":"Local Agent Server","href":"/sdk/guides/agent-server/local-server"},{"title":"Agent Server Package","href":"/sdk/arch/agent-server"},{"title":"Conversation Goals","href":"/sdk/guides/agent-server/conversation-goals"},{"title":"Docker Sandbox","href":"/sdk/guides/agent-server/docker-sandbox"},{"title":"Apptainer Sandbox","href":"/sdk/guides/agent-server/apptainer-sandbox"},{"title":"API-based Sandbox","href":"/sdk/guides/agent-server/api-sandbox"},{"title":"OpenHands Cloud Workspace","href":"/sdk/guides/agent-server/cloud-workspace"},{"title":"Custom Tools with Remote Agent Server","href":"/sdk/guides/agent-server/custom-tools"},{"title":"OpenAI-Compatible Endpoint","href":"/sdk/guides/agent-server/openai-gateway"},{"title":"Deferred Init (Warm-Pool)","href":"/sdk/guides/agent-server/deferred-init"},{"group":"API Reference","pages":[{"group":"Server Details","pages":[{"title":"Alive","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /alive","href":"/sdk/guides/agent-server/api-reference/server-details/alive"},{"title":"Health","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /health","href":"/sdk/guides/agent-server/api-reference/server-details/health"},{"title":"Ready","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /ready","href":"/sdk/guides/agent-server/api-reference/server-details/ready"},{"title":"Get Server Info","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /server_info","href":"/sdk/guides/agent-server/api-reference/server-details/get-server-info"}]},{"group":"Events","pages":[{"title":"Search Conversation Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/{conversation_id}/events/search","href":"/sdk/guides/agent-server/api-reference/events/search-conversation-events"},{"title":"Count Conversation Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/{conversation_id}/events/count","href":"/sdk/guides/agent-server/api-reference/events/count-conversation-events"},{"title":"Get Conversation Event","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/{conversation_id}/events/{event_id}","href":"/sdk/guides/agent-server/api-reference/events/get-conversation-event"},{"title":"Batch Get Conversation Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/{conversation_id}/events","href":"/sdk/guides/agent-server/api-reference/events/batch-get-conversation-events"},{"title":"Send Message","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/events","href":"/sdk/guides/agent-server/api-reference/events/send-message"},{"title":"Respond To Confirmation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/events/respond_to_confirmation","href":"/sdk/guides/agent-server/api-reference/events/respond-to-confirmation"}]},{"group":"Conversations","pages":[{"title":"Search Conversations","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/search","href":"/sdk/guides/agent-server/api-reference/conversations/search-conversations"},{"title":"Count Conversations","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/count","href":"/sdk/guides/agent-server/api-reference/conversations/count-conversations"},{"title":"Get Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations/{conversation_id}","href":"/sdk/guides/agent-server/api-reference/conversations/get-conversation"},{"title":"Delete Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json delete /api/conversations/{conversation_id}","href":"/sdk/guides/agent-server/api-reference/conversations/delete-conversation"},{"title":"Update Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json patch /api/conversations/{conversation_id}","href":"/sdk/guides/agent-server/api-reference/conversations/update-conversation"},{"title":"Batch Get Conversations","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/conversations","href":"/sdk/guides/agent-server/api-reference/conversations/batch-get-conversations"},{"title":"Start Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations","href":"/sdk/guides/agent-server/api-reference/conversations/start-conversation"},{"title":"Pause Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/pause","href":"/sdk/guides/agent-server/api-reference/conversations/pause-conversation"},{"title":"Run Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/run","href":"/sdk/guides/agent-server/api-reference/conversations/run-conversation"},{"title":"Update Conversation Secrets","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/secrets","href":"/sdk/guides/agent-server/api-reference/conversations/update-conversation-secrets"},{"title":"Set Conversation Confirmation Policy","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/confirmation_policy","href":"/sdk/guides/agent-server/api-reference/conversations/set-conversation-confirmation-policy"},{"title":"Set Conversation Security Analyzer","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/security_analyzer","href":"/sdk/guides/agent-server/api-reference/conversations/set-conversation-security-analyzer"},{"title":"Generate Conversation Title","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/generate_title","href":"/sdk/guides/agent-server/api-reference/conversations/generate-conversation-title"},{"title":"Ask Agent","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/ask_agent","href":"/sdk/guides/agent-server/api-reference/conversations/ask-agent"},{"title":"Condense Conversation","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/conversations/{conversation_id}/condense","href":"/sdk/guides/agent-server/api-reference/conversations/condense-conversation"}]},{"group":"Tools","pages":[{"title":"List Available Tools","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/tools/","href":"/sdk/guides/agent-server/api-reference/tools/list-available-tools"}]},{"group":"Bash","pages":[{"title":"Search Bash Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/bash/bash_events/search","href":"/sdk/guides/agent-server/api-reference/bash/search-bash-events"},{"title":"Get Bash Event","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/bash/bash_events/{event_id}","href":"/sdk/guides/agent-server/api-reference/bash/get-bash-event"},{"title":"Batch Get Bash Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/bash/bash_events/","href":"/sdk/guides/agent-server/api-reference/bash/batch-get-bash-events"},{"title":"Start Bash Command","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/bash/start_bash_command","href":"/sdk/guides/agent-server/api-reference/bash/start-bash-command"},{"title":"Execute Bash Command","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/bash/execute_bash_command","href":"/sdk/guides/agent-server/api-reference/bash/execute-bash-command"},{"title":"Clear All Bash Events","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json delete /api/bash/bash_events","href":"/sdk/guides/agent-server/api-reference/bash/clear-all-bash-events"}]},{"group":"Git","pages":[{"title":"Git Changes","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/git/changes/{path}","href":"/sdk/guides/agent-server/api-reference/git/git-changes"},{"title":"Git Diff","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/git/diff/{path}","href":"/sdk/guides/agent-server/api-reference/git/git-diff"}]},{"group":"Files","pages":[{"title":"Upload File","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/file/upload/{path}","href":"/sdk/guides/agent-server/api-reference/files/upload-file"},{"title":"Download File","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/file/download/{path}","href":"/sdk/guides/agent-server/api-reference/files/download-file"},{"title":"Download Trajectory","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/file/download-trajectory/{conversation_id}","href":"/sdk/guides/agent-server/api-reference/files/download-trajectory"}]},{"group":"VSCode","pages":[{"title":"Get Vscode Url","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/vscode/url","href":"/sdk/guides/agent-server/api-reference/vscode/get-vscode-url"},{"title":"Get Vscode Status","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/vscode/status","href":"/sdk/guides/agent-server/api-reference/vscode/get-vscode-status"}]},{"group":"Desktop","pages":[{"title":"Get Desktop Url","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /api/desktop/url","href":"/sdk/guides/agent-server/api-reference/desktop/get-desktop-url"}]},{"group":"Skills","pages":[{"title":"Get Skills","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/skills","href":"/sdk/guides/agent-server/api-reference/skills/get-skills"},{"title":"Sync Skills","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/skills/sync","href":"/sdk/guides/agent-server/api-reference/skills/sync-skills"}]},{"group":"Hooks","pages":[{"title":"Get Hooks","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json post /api/hooks","href":"/sdk/guides/agent-server/api-reference/hooks/get-hooks"}]},{"group":"API Reference","pages":[{"title":"Get Server Info","deprecated":null,"version":null,"openapi":"/openapi/agent-sdk.json get /","href":"/sdk/guides/agent-server/api-reference/get-server-info"}]}]}]},{"group":"GitHub Workflows","pages":[{"title":"Assign Reviews","href":"/sdk/guides/github-workflows/assign-reviews"},{"title":"PR Review","href":"/sdk/guides/github-workflows/pr-review"},{"title":"TODO Management","href":"/sdk/guides/github-workflows/todo-management"}]}]},{"group":"Architecture","pages":[{"title":"Overview","href":"/sdk/arch/overview"},{"title":"Design Principles","href":"/sdk/arch/design"},{"group":"SDK Components","pages":[{"title":"Agent","href":"/sdk/arch/agent"},{"title":"Conversation","href":"/sdk/arch/conversation"},{"title":"Tool System \u0026 MCP","href":"/sdk/arch/tool-system"},{"title":"MCP Integration","href":"/sdk/arch/mcp"},{"title":"Events","href":"/sdk/arch/events"},{"title":"Workspace","href":"/sdk/arch/workspace"},{"title":"LLM","href":"/sdk/arch/llm"},{"title":"Skill","href":"/sdk/arch/skill"},{"title":"Condenser","href":"/sdk/arch/condenser"},{"title":"Security","href":"/sdk/arch/security"}]}]},{"group":"API Reference","pages":[{"title":"openhands.sdk.agent","href":"/sdk/api-reference/openhands.sdk.agent"},{"title":"openhands.sdk.conversation","href":"/sdk/api-reference/openhands.sdk.conversation"},{"title":"openhands.sdk.event","href":"/sdk/api-reference/openhands.sdk.event"},{"title":"openhands.sdk.llm","href":"/sdk/api-reference/openhands.sdk.llm"},{"title":"openhands.sdk.security","href":"/sdk/api-reference/openhands.sdk.security"},{"title":"openhands.sdk.tool","href":"/sdk/api-reference/openhands.sdk.tool"},{"title":"openhands.sdk.utils","href":"/sdk/api-reference/openhands.sdk.utils"},{"title":"openhands.sdk.workspace","href":"/sdk/api-reference/openhands.sdk.workspace"}]}]},{"tab":"Cloud","pages":[{"group":"OpenHands Cloud","pages":[{"title":"Getting Started","href":"/openhands/usage/cloud/openhands-cloud"},{"title":"Cloud UI","href":"/openhands/usage/cloud/cloud-ui"}]},{"group":"Settings","pages":[{"title":"API Keys Settings","href":"/openhands/usage/settings/api-keys-settings"}]},{"group":"Integrations","pages":[{"title":"Integrations Settings","href":"/openhands/usage/settings/integrations-settings"},{"title":"GitHub Integration","href":"/openhands/usage/cloud/github-installation"},{"title":"GitLab Integration","href":"/openhands/usage/cloud/gitlab-installation"},{"title":"Bitbucket Integration","href":"/openhands/usage/cloud/bitbucket-installation"},{"title":"Slack Integration","href":"/openhands/usage/cloud/slack-installation"},{"title":"Jira Cloud Integration","href":"/openhands/usage/cloud/project-management/jira-integration"}]},{"group":"Cloud API","pages":[{"title":"Cloud API Overview","href":"/openhands/usage/cloud/cloud-api"},{"title":"Plugin Launcher","href":"/openhands/usage/cloud/plugin-launcher"},{"group":"REST API Reference","expanded":false,"pages":[{"group":"Events","pages":[{"title":"Search Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/conversation/{conversation_id}/events/search","href":"/openhands/usage/cloud/api-reference/events/search-events"},{"title":"Count Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/conversation/{conversation_id}/events/count","href":"/openhands/usage/cloud/api-reference/events/count-events"},{"title":"Batch Get Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/conversation/{conversation_id}/events","href":"/openhands/usage/cloud/api-reference/events/batch-get-events"}]},{"group":"Conversations","pages":[{"title":"Search App Conversations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/search","href":"/openhands/usage/cloud/api-reference/conversations/search-app-conversations"},{"title":"Count App Conversations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/count","href":"/openhands/usage/cloud/api-reference/conversations/count-app-conversations"},{"title":"Batch Get App Conversations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations","href":"/openhands/usage/cloud/api-reference/conversations/batch-get-app-conversations"},{"title":"Start App Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/app-conversations","href":"/openhands/usage/cloud/api-reference/conversations/start-app-conversation"},{"title":"Delete App Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/v1/app-conversations/{conversation_id}","href":"/openhands/usage/cloud/api-reference/conversations/delete-app-conversation"},{"title":"Update App Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json patch /api/v1/app-conversations/{conversation_id}","href":"/openhands/usage/cloud/api-reference/conversations/update-app-conversation"},{"title":"Send Message To Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/app-conversations/{conversation_id}/send-message","href":"/openhands/usage/cloud/api-reference/conversations/send-message-to-conversation"},{"title":"Switch Conversation Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/app-conversations/{conversation_id}/switch_profile","href":"/openhands/usage/cloud/api-reference/conversations/switch-conversation-profile"},{"title":"Switch Conversation Acp Model","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/app-conversations/{conversation_id}/switch_acp_model","href":"/openhands/usage/cloud/api-reference/conversations/switch-conversation-acp-model"},{"title":"Stream App Conversation Start","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/app-conversations/stream-start","href":"/openhands/usage/cloud/api-reference/conversations/stream-app-conversation-start"},{"title":"Search App Conversation Start Tasks","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/start-tasks/search","href":"/openhands/usage/cloud/api-reference/conversations/search-app-conversation-start-tasks"},{"title":"Count App Conversation Start Tasks","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/start-tasks/count","href":"/openhands/usage/cloud/api-reference/conversations/count-app-conversation-start-tasks"},{"title":"Batch Get App Conversation Start Tasks","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/start-tasks","href":"/openhands/usage/cloud/api-reference/conversations/batch-get-app-conversation-start-tasks"},{"title":"Read Conversation File","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/file","href":"/openhands/usage/cloud/api-reference/conversations/read-conversation-file"},{"title":"Get Conversation Git Changes","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/git/changes","href":"/openhands/usage/cloud/api-reference/conversations/get-conversation-git-changes"},{"title":"Get Conversation Git Diff","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/git/diff","href":"/openhands/usage/cloud/api-reference/conversations/get-conversation-git-diff"},{"title":"Get Conversation Skills","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/skills","href":"/openhands/usage/cloud/api-reference/conversations/get-conversation-skills"},{"title":"Get Conversation Hooks","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/hooks","href":"/openhands/usage/cloud/api-reference/conversations/get-conversation-hooks"},{"title":"Export Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/app-conversations/{conversation_id}/download","href":"/openhands/usage/cloud/api-reference/conversations/export-conversation"}]},{"group":"Pending Messages","pages":[{"title":"Queue Pending Message","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/conversations/{conversation_id}/pending-messages","href":"/openhands/usage/cloud/api-reference/pending-messages/queue-pending-message"}]},{"group":"Sandbox","pages":[{"title":"Search Sandboxes","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandboxes/search","href":"/openhands/usage/cloud/api-reference/sandbox/search-sandboxes"},{"title":"Batch Get Sandboxes","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandboxes","href":"/openhands/usage/cloud/api-reference/sandbox/batch-get-sandboxes"},{"title":"Start Sandbox","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/sandboxes","href":"/openhands/usage/cloud/api-reference/sandbox/start-sandbox"},{"title":"Pause Sandbox","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/sandboxes/{sandbox_id}/pause","href":"/openhands/usage/cloud/api-reference/sandbox/pause-sandbox"},{"title":"Resume Sandbox","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/sandboxes/{sandbox_id}/resume","href":"/openhands/usage/cloud/api-reference/sandbox/resume-sandbox"},{"title":"Delete Sandbox","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/v1/sandboxes/{id}","href":"/openhands/usage/cloud/api-reference/sandbox/delete-sandbox"},{"title":"List Secret Names","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandboxes/{sandbox_id}/settings/secrets","href":"/openhands/usage/cloud/api-reference/sandbox/list-secret-names"},{"title":"Get Secret Value","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandboxes/{sandbox_id}/settings/secrets/{secret_name}","href":"/openhands/usage/cloud/api-reference/sandbox/get-secret-value"},{"title":"Search Sandbox Specs","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandbox-specs/search","href":"/openhands/usage/cloud/api-reference/sandbox/search-sandbox-specs"},{"title":"Batch Get Sandbox Specs","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/sandbox-specs","href":"/openhands/usage/cloud/api-reference/sandbox/batch-get-sandbox-specs"}]},{"group":"Settings","pages":[{"title":"Load Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/settings","href":"/openhands/usage/cloud/api-reference/settings/load-settings"},{"title":"Store Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/settings","href":"/openhands/usage/cloud/api-reference/settings/store-settings"},{"title":"Load Settings Schema","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/settings/agent-schema","href":"/openhands/usage/cloud/api-reference/settings/load-settings-schema"},{"title":"Load Conversation Settings Schema","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/settings/conversation-schema","href":"/openhands/usage/cloud/api-reference/settings/load-conversation-settings-schema"},{"title":"List Profiles","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/settings/profiles","href":"/openhands/usage/cloud/api-reference/settings/list-profiles"},{"title":"Get Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/settings/profiles/{name}","href":"/openhands/usage/cloud/api-reference/settings/get-profile"},{"title":"Save Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/settings/profiles/{name}","href":"/openhands/usage/cloud/api-reference/settings/save-profile"},{"title":"Delete Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/v1/settings/profiles/{name}","href":"/openhands/usage/cloud/api-reference/settings/delete-profile"},{"title":"Activate Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/settings/profiles/{name}/activate","href":"/openhands/usage/cloud/api-reference/settings/activate-profile"},{"title":"Rename Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/settings/profiles/{name}/rename","href":"/openhands/usage/cloud/api-reference/settings/rename-profile"}]},{"group":"Secrets","pages":[{"title":"Store Provider Tokens","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/secrets/git-providers","href":"/openhands/usage/cloud/api-reference/secrets/store-provider-tokens"},{"title":"Unset Provider Tokens","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/v1/secrets/git-providers","href":"/openhands/usage/cloud/api-reference/secrets/unset-provider-tokens"},{"title":"Search Custom Secrets","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/secrets/search","href":"/openhands/usage/cloud/api-reference/secrets/search-custom-secrets"},{"title":"Create Custom Secret","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/secrets","href":"/openhands/usage/cloud/api-reference/secrets/create-custom-secret"},{"title":"Update Custom Secret","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json put /api/v1/secrets/{secret_id}","href":"/openhands/usage/cloud/api-reference/secrets/update-custom-secret"},{"title":"Delete Custom Secret","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/v1/secrets/{secret_id}","href":"/openhands/usage/cloud/api-reference/secrets/delete-custom-secret"}]},{"group":"User","pages":[{"title":"Get Current User Git Info","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/users/git-info","href":"/openhands/usage/cloud/api-reference/user/get-current-user-git-info"},{"title":"Get Current User Saas","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/users/me","href":"/openhands/usage/cloud/api-reference/user/get-current-user-saas"},{"title":"Get Current User Git Organizations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/users/git-organizations","href":"/openhands/usage/cloud/api-reference/user/get-current-user-git-organizations"}]},{"group":"Skills","pages":[{"title":"Search Skills","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/skills/search","href":"/openhands/usage/cloud/api-reference/skills/search-skills"},{"title":"Get Marketplace Skills","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/skills/marketplace-skills","href":"/openhands/usage/cloud/api-reference/skills/get-marketplace-skills"}]},{"group":"Webhooks","pages":[{"title":"On Conversation Update","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/webhooks/conversations","href":"/openhands/usage/cloud/api-reference/webhooks/on-conversation-update"},{"title":"On Event","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/v1/webhooks/events/{conversation_id}","href":"/openhands/usage/cloud/api-reference/webhooks/on-event"},{"title":"Get Secret","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/webhooks/secrets","href":"/openhands/usage/cloud/api-reference/webhooks/get-secret"}]},{"group":"Config","pages":[{"title":"Get Web Client Config","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/web-client/config","href":"/openhands/usage/cloud/api-reference/config/get-web-client-config"},{"title":"Search Models","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/config/models/search","href":"/openhands/usage/cloud/api-reference/config/search-models"},{"title":"Search Providers","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/config/providers/search","href":"/openhands/usage/cloud/api-reference/config/search-providers"}]},{"group":"Git","pages":[{"title":"Search User Installations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/git/installations/search","href":"/openhands/usage/cloud/api-reference/git/search-user-installations"},{"title":"Search Repositories","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/git/repositories/search","href":"/openhands/usage/cloud/api-reference/git/search-repositories"},{"title":"Search Branches","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/git/branches/search","href":"/openhands/usage/cloud/api-reference/git/search-branches"},{"title":"Search Suggested Tasks","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/v1/git/suggested-tasks/search","href":"/openhands/usage/cloud/api-reference/git/search-suggested-tasks"}]},{"group":"Status","pages":[{"title":"Alive","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /alive","href":"/openhands/usage/cloud/api-reference/status/alive"},{"title":"Health","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /health","href":"/openhands/usage/cloud/api-reference/status/health"},{"title":"Get Server Info","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /server_info","href":"/openhands/usage/cloud/api-reference/status/get-server-info"}]},{"group":"API Reference","pages":[{"title":"Is Ready","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /ready","href":"/openhands/usage/cloud/api-reference/is-ready"},{"title":"Is Saas","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /saas","href":"/openhands/usage/cloud/api-reference/is-saas"},{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/authenticate","href":"/openhands/usage/cloud/api-reference/authenticate"},{"title":"Accept Tos","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/accept_tos","href":"/openhands/usage/cloud/api-reference/accept-tos"},{"title":"Onboarding Status","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/onboarding_status","href":"/openhands/usage/cloud/api-reference/onboarding-status"},{"title":"Complete Onboarding","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/complete_onboarding","href":"/openhands/usage/cloud/api-reference/complete-onboarding"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/logout","href":"/openhands/usage/cloud/api-reference/logout"},{"title":"Refresh Tokens","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/refresh-tokens","href":"/openhands/usage/cloud/api-reference/refresh-tokens"},{"title":"Keycloak Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /oauth/keycloak/callback","href":"/openhands/usage/cloud/api-reference/keycloak-callback"},{"title":"Keycloak Offline Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /oauth/keycloak/offline/callback","href":"/openhands/usage/cloud/api-reference/keycloak-offline-callback"},{"title":"Github Dummy Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /oauth/github/callback","href":"/openhands/usage/cloud/api-reference/github-dummy-callback"},{"title":"Device Authorization","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /oauth/device/authorize","href":"/openhands/usage/cloud/api-reference/device-authorization"},{"title":"Device Token","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /oauth/device/token","href":"/openhands/usage/cloud/api-reference/device-token"},{"title":"Device Verification Authenticated","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /oauth/device/verify-authenticated","href":"/openhands/usage/cloud/api-reference/device-verification-authenticated"},{"title":"Get User App Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/users/app","href":"/openhands/usage/cloud/api-reference/get-user-app-settings"},{"title":"Update User App Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/users/app","href":"/openhands/usage/cloud/api-reference/update-user-app-settings"},{"title":"Github Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/github/events","href":"/openhands/usage/cloud/api-reference/github-events"},{"title":"Gitlab Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/gitlab/events","href":"/openhands/usage/cloud/api-reference/gitlab-events"},{"title":"Get Gitlab Resources","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /integration/gitlab/resources","href":"/openhands/usage/cloud/api-reference/get-gitlab-resources"},{"title":"Reinstall Gitlab Webhook","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/gitlab/reinstall-webhook","href":"/openhands/usage/cloud/api-reference/reinstall-gitlab-webhook"},{"title":"Bitbucket Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/bitbucket/events","href":"/openhands/usage/cloud/api-reference/bitbucket-events"},{"title":"List Pending Invitations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/members/invite","href":"/openhands/usage/cloud/api-reference/list-pending-invitations"},{"title":"Create Invitation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/members/invite","href":"/openhands/usage/cloud/api-reference/create-invitation"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}/members/invite/{invitation_id}","href":"/openhands/usage/cloud/api-reference/revoke-invitation"},{"title":"Accept Invitation Redirect","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/members/invite/accept","href":"/openhands/usage/cloud/api-reference/accept-invitation-redirect"},{"title":"Accept Invitation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/members/invite/accept","href":"/openhands/usage/cloud/api-reference/accept-invitation"},{"title":"Install","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /slack/install","href":"/openhands/usage/cloud/api-reference/install"},{"title":"Install Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /slack/install-callback","href":"/openhands/usage/cloud/api-reference/install-callback"},{"title":"Keycloak Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /slack/keycloak-callback","href":"/openhands/usage/cloud/api-reference/keycloak-callback-1"},{"title":"On Event","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /slack/on-event","href":"/openhands/usage/cloud/api-reference/on-event"},{"title":"On Options Load","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /slack/on-options-load","href":"/openhands/usage/cloud/api-reference/on-options-load"},{"title":"On Form Interaction","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /slack/on-form-interaction","href":"/openhands/usage/cloud/api-reference/on-form-interaction"},{"title":"Jira Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/jira/events","href":"/openhands/usage/cloud/api-reference/jira-events"},{"title":"Create Jira Workspace","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/jira/workspaces","href":"/openhands/usage/cloud/api-reference/create-jira-workspace"},{"title":"Get Current Workspace Link","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /integration/jira/workspaces/link","href":"/openhands/usage/cloud/api-reference/get-current-workspace-link"},{"title":"Create Workspace Link","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/jira/workspaces/link","href":"/openhands/usage/cloud/api-reference/create-workspace-link"},{"title":"Jira Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /integration/jira/callback","href":"/openhands/usage/cloud/api-reference/jira-callback"},{"title":"Unlink Workspace","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /integration/jira/workspaces/unlink","href":"/openhands/usage/cloud/api-reference/unlink-workspace"},{"title":"Validate Workspace Integration","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /integration/jira/workspaces/validate/{workspace_name}","href":"/openhands/usage/cloud/api-reference/validate-workspace-integration"},{"title":"Update Email","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/email","href":"/openhands/usage/cloud/api-reference/update-email"},{"title":"Resend Email Verification","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json put /api/email/resend","href":"/openhands/usage/cloud/api-reference/resend-email-verification"},{"title":"Verified Email","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/email/verified","href":"/openhands/usage/cloud/api-reference/verified-email"}]},{"group":"Billing","pages":[{"title":"Get Credits","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/billing/credits","href":"/openhands/usage/cloud/api-reference/billing/get-credits"},{"title":"Get Subscription Access","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/billing/subscription-access","href":"/openhands/usage/cloud/api-reference/billing/get-subscription-access"},{"title":"Has Payment Method","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/billing/has-payment-method","href":"/openhands/usage/cloud/api-reference/billing/has-payment-method"},{"title":"Create Customer Setup Session","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/billing/create-customer-setup-session","href":"/openhands/usage/cloud/api-reference/billing/create-customer-setup-session"},{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/billing/create-checkout-session","href":"/openhands/usage/cloud/api-reference/billing/create-checkout-session"},{"title":"Success Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/billing/success","href":"/openhands/usage/cloud/api-reference/billing/success-callback"},{"title":"Cancel Callback","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/billing/cancel","href":"/openhands/usage/cloud/api-reference/billing/cancel-callback"}]},{"group":"Sharing","pages":[{"title":"Batch Get Shared Conversations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/shared-conversations","href":"/openhands/usage/cloud/api-reference/sharing/batch-get-shared-conversations"},{"title":"Search Shared Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/shared-events/search","href":"/openhands/usage/cloud/api-reference/sharing/search-shared-events"},{"title":"Count Shared Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/shared-events/count","href":"/openhands/usage/cloud/api-reference/sharing/count-shared-events"},{"title":"Batch Get Shared Events","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/shared-events","href":"/openhands/usage/cloud/api-reference/sharing/batch-get-shared-events"},{"title":"Get Shared Event","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/shared-events/{conversation_id}/{event_id}","href":"/openhands/usage/cloud/api-reference/sharing/get-shared-event"}]},{"group":"Keys","pages":[{"title":"Check Byor Permitted","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/keys/llm/byor/permitted","href":"/openhands/usage/cloud/api-reference/keys/check-byor-permitted"},{"title":"List Api Keys","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/keys","href":"/openhands/usage/cloud/api-reference/keys/list-api-keys"},{"title":"Create Api Key","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/keys","href":"/openhands/usage/cloud/api-reference/keys/create-api-key"},{"title":"Delete Api Key","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/keys/{key_id}","href":"/openhands/usage/cloud/api-reference/keys/delete-api-key"},{"title":"Get Current Api Key","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/keys/current","href":"/openhands/usage/cloud/api-reference/keys/get-current-api-key"},{"title":"Refresh Managed Llm Api Key","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/keys/llm/managed/refresh","href":"/openhands/usage/cloud/api-reference/keys/refresh-managed-llm-api-key"},{"title":"Get Llm Api Key For Byor","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/keys/llm/byor","href":"/openhands/usage/cloud/api-reference/keys/get-llm-api-key-for-byor"},{"title":"Refresh Llm Api Key For Byor","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/keys/llm/byor/refresh","href":"/openhands/usage/cloud/api-reference/keys/refresh-llm-api-key-for-byor"}]},{"group":"Service","pages":[{"title":"Service Health","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/service/health","href":"/openhands/usage/cloud/api-reference/service/service-health"},{"title":"Get Or Create Api Key For User","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/service/users/{user_id}/orgs/{org_id}/api-keys","href":"/openhands/usage/cloud/api-reference/service/get-or-create-api-key-for-user"},{"title":"Delete User Api Key","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/service/users/{user_id}/orgs/{org_id}/api-keys/{key_name}","href":"/openhands/usage/cloud/api-reference/service/delete-user-api-key"}]},{"group":"Orgs","pages":[{"title":"List User Orgs","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations","href":"/openhands/usage/cloud/api-reference/orgs/list-user-orgs"},{"title":"Create Org","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations","href":"/openhands/usage/cloud/api-reference/orgs/create-org"},{"title":"Get Org Defaults Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/settings","href":"/openhands/usage/cloud/api-reference/orgs/get-org-defaults-settings"},{"title":"Update Org Defaults Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json patch /api/organizations/{org_id}/settings","href":"/openhands/usage/cloud/api-reference/orgs/update-org-defaults-settings"},{"title":"Get Legacy Org Defaults Settings","deprecated":true,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/llm","href":"/openhands/usage/cloud/api-reference/orgs/get-legacy-org-defaults-settings"},{"title":"Update Legacy Org Defaults Settings","deprecated":true,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/llm","href":"/openhands/usage/cloud/api-reference/orgs/update-legacy-org-defaults-settings"},{"title":"Get Org App Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/app","href":"/openhands/usage/cloud/api-reference/orgs/get-org-app-settings"},{"title":"Update Org App Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/app","href":"/openhands/usage/cloud/api-reference/orgs/update-org-app-settings"},{"title":"Get Org","deprecated":true,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}","href":"/openhands/usage/cloud/api-reference/orgs/get-org"},{"title":"Delete Org","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}","href":"/openhands/usage/cloud/api-reference/orgs/delete-org"},{"title":"Update Org","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json patch /api/organizations/{org_id}","href":"/openhands/usage/cloud/api-reference/orgs/update-org"},{"title":"Get Me","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/me","href":"/openhands/usage/cloud/api-reference/orgs/get-me"},{"title":"Get Org Members","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/members","href":"/openhands/usage/cloud/api-reference/orgs/get-org-members"},{"title":"Get Org Members Count","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/members/count","href":"/openhands/usage/cloud/api-reference/orgs/get-org-members-count"},{"title":"Get Org Members Financial","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/members/financial","href":"/openhands/usage/cloud/api-reference/orgs/get-org-members-financial"},{"title":"Get Org Budget Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/budgets","href":"/openhands/usage/cloud/api-reference/orgs/get-org-budget-settings"},{"title":"Update Org Budget Settings","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json patch /api/organizations/{org_id}/budgets","href":"/openhands/usage/cloud/api-reference/orgs/update-org-budget-settings"},{"title":"Upsert Org Budget Override","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json put /api/organizations/{org_id}/budgets/overrides/{user_id}","href":"/openhands/usage/cloud/api-reference/orgs/upsert-org-budget-override"},{"title":"Delete Org Budget Override","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}/budgets/overrides/{user_id}","href":"/openhands/usage/cloud/api-reference/orgs/delete-org-budget-override"},{"title":"Remove Org Member","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}/members/{user_id}","href":"/openhands/usage/cloud/api-reference/orgs/remove-org-member"},{"title":"Update Org Member","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json patch /api/organizations/{org_id}/members/{user_id}","href":"/openhands/usage/cloud/api-reference/orgs/update-org-member"},{"title":"Switch Org","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/switch","href":"/openhands/usage/cloud/api-reference/orgs/switch-org"},{"title":"Get Git Claims","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/git-claims","href":"/openhands/usage/cloud/api-reference/orgs/get-git-claims"},{"title":"Claim Git Organization","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/git-claims","href":"/openhands/usage/cloud/api-reference/orgs/claim-git-organization"},{"title":"Disconnect Git Organization","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}/git-claims/{claim_id}","href":"/openhands/usage/cloud/api-reference/orgs/disconnect-git-organization"},{"title":"List Org Conversations","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations","href":"/openhands/usage/cloud/api-reference/orgs/list-org-conversations"},{"title":"Get Org Conversation Stats","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations/stats","href":"/openhands/usage/cloud/api-reference/orgs/get-org-conversation-stats"},{"title":"Get Org Conversation Usage Stats","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations/usage-stats","href":"/openhands/usage/cloud/api-reference/orgs/get-org-conversation-usage-stats"},{"title":"Get Org Conversation User Usage Stats","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations/user-usage","href":"/openhands/usage/cloud/api-reference/orgs/get-org-conversation-user-usage-stats"},{"title":"Export Org Conversations Csv","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations/export","href":"/openhands/usage/cloud/api-reference/orgs/export-org-conversations-csv"},{"title":"Get Org Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/conversations/{conversation_id}","href":"/openhands/usage/cloud/api-reference/orgs/get-org-conversation"},{"title":"Stop Org Conversation","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/conversations/{conversation_id}/stop","href":"/openhands/usage/cloud/api-reference/orgs/stop-org-conversation"}]},{"group":"Admin","pages":[{"title":"List Super Admins","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/admin/super-admins","href":"/openhands/usage/cloud/api-reference/admin/list-super-admins"},{"title":"Grant Super Admin","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/admin/super-admins","href":"/openhands/usage/cloud/api-reference/admin/grant-super-admin"},{"title":"Revoke Super Admin","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/admin/super-admins/{user_id}","href":"/openhands/usage/cloud/api-reference/admin/revoke-super-admin"}]},{"group":"Organization Profiles","pages":[{"title":"List Profiles","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/profiles","href":"/openhands/usage/cloud/api-reference/organization-profiles/list-profiles"},{"title":"Get Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/organizations/{org_id}/profiles/{name}","href":"/openhands/usage/cloud/api-reference/organization-profiles/get-profile"},{"title":"Save Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/profiles/{name}","href":"/openhands/usage/cloud/api-reference/organization-profiles/save-profile"},{"title":"Delete Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/organizations/{org_id}/profiles/{name}","href":"/openhands/usage/cloud/api-reference/organization-profiles/delete-profile"},{"title":"Activate Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/profiles/{name}/activate","href":"/openhands/usage/cloud/api-reference/organization-profiles/activate-profile"},{"title":"Rename Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/organizations/{org_id}/profiles/{name}/rename","href":"/openhands/usage/cloud/api-reference/organization-profiles/rename-profile"}]},{"group":"Agent Profiles","pages":[{"title":"List Agent Profiles","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/agent-profiles","href":"/openhands/usage/cloud/api-reference/agent-profiles/list-agent-profiles"},{"title":"Get Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/agent-profiles/{name}","href":"/openhands/usage/cloud/api-reference/agent-profiles/get-agent-profile"},{"title":"Save Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/agent-profiles/{name}","href":"/openhands/usage/cloud/api-reference/agent-profiles/save-agent-profile"},{"title":"Delete Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/agent-profiles/{name}","href":"/openhands/usage/cloud/api-reference/agent-profiles/delete-agent-profile"},{"title":"Rename Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/agent-profiles/{name}/rename","href":"/openhands/usage/cloud/api-reference/agent-profiles/rename-agent-profile"},{"title":"Activate Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/agent-profiles/{profile_id}/activate","href":"/openhands/usage/cloud/api-reference/agent-profiles/activate-agent-profile"},{"title":"Materialize Agent Profile","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/agent-profiles/{name}/materialize","href":"/openhands/usage/cloud/api-reference/agent-profiles/materialize-agent-profile"}]},{"group":"Verified Models","pages":[{"title":"Search Verified Models","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json get /api/admin/verified-models","href":"/openhands/usage/cloud/api-reference/verified-models/search-verified-models"},{"title":"Create Verified Model","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/admin/verified-models","href":"/openhands/usage/cloud/api-reference/verified-models/create-verified-model"},{"title":"Update Verified Model","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json put /api/admin/verified-models/{provider}/{model_name}","href":"/openhands/usage/cloud/api-reference/verified-models/update-verified-model"},{"title":"Delete Verified Model","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json delete /api/admin/verified-models/{provider}/{model_name}","href":"/openhands/usage/cloud/api-reference/verified-models/delete-verified-model"}]},{"group":"Analytics","pages":[{"title":"Track Frontend Event","deprecated":null,"version":null,"openapi":"/openapi/openhands-cloud.json post /api/analytics/events","href":"/openhands/usage/cloud/api-reference/analytics/track-frontend-event"}]}]}]}]},{"tab":"Enterprise","pages":[{"group":"Get Started","pages":[{"group":"Why Enterprise","icon":"building","root":{"title":"OpenHands Enterprise","icon":"building","href":"/enterprise"},"pages":[{"title":"Enterprise vs. Open Source","sidebarTitle":"Enterprise vs. OSS","icon":"scale-balanced","href":"/enterprise/enterprise-vs-oss"}]},{"title":"Architecture","icon":"sitemap","href":"/enterprise/architecture"}]},{"group":"Deployment","pages":[{"title":"Sizing Guide","icon":"ruler","href":"/enterprise/sizing-guide"},{"group":"Kubernetes","icon":"dharmachakra","root":{"title":"Kubernetes Installation","icon":"dharmachakra","href":"/enterprise/k8s-install/index"},"pages":[{"group":"Cloud Providers","icon":"cloud","pages":[{"title":"Amazon EKS","icon":"aws","href":"/enterprise/k8s-install/eks"},{"title":"Azure AKS","icon":"https://mintlify.s3.us-west-1.amazonaws.com/allhandsai/enterprise/images/azure-logo.svg","href":"/enterprise/k8s-install/aks"},{"title":"Google GKE","icon":"cloud","href":"/enterprise/k8s-install/gke"}]},{"title":"Installing Sysbox","sidebarTitle":"Sysbox","icon":"cube","href":"/enterprise/k8s-install/sysbox"},{"title":"DNS and TLS","icon":"lock","href":"/enterprise/k8s-install/dns-and-tls"},{"title":"Install with Helm","sidebarTitle":"Install with Helm","icon":"ship","href":"/enterprise/k8s-install/installation"},{"title":"Resource Limits","icon":"gauge-high","href":"/enterprise/k8s-install/resource-limits"},{"title":"Enable Automations with Helm","sidebarTitle":"Automations","icon":"clock","href":"/enterprise/k8s-install/automations"},{"title":"Upgrade Guidance","icon":"circle-up","href":"/enterprise/k8s-install/upgrade-guidance"}]},{"group":"VM Install","icon":"server","pages":[{"title":"Generic VM Quick Start","sidebarTitle":"Generic VM","icon":"server","href":"/enterprise/vm-install/generic-vm"},{"title":"AWS Quick Start","sidebarTitle":"AWS","icon":"aws","href":"/enterprise/vm-install/aws"},{"title":"Google Cloud Quick Start","sidebarTitle":"Google Cloud","icon":"google","href":"/enterprise/vm-install/google"},{"title":"Azure Quick Start","sidebarTitle":"Azure","icon":"microsoft","href":"/enterprise/vm-install/azure"},{"title":"Admin Console Configuration","sidebarTitle":"Admin Console","icon":"sliders","href":"/enterprise/vm-install/admin-console-configuration"},{"title":"Log Collection","icon":"file-lines","href":"/enterprise/vm-install/log-collection"},{"title":"Scaling the Cluster","sidebarTitle":"Scaling","icon":"server","href":"/enterprise/vm-install/scaling"}]},{"group":"Compose","icon":"docker","root":{"title":"Docker Compose","icon":"docker","href":"/enterprise/docker-compose"},"tag":"Experimental","pages":[{"title":"Run on a VM with HTTPS","sidebarTitle":"VM with HTTPS","icon":"lock","href":"/enterprise/docker-compose/https"},{"title":"Serve with ngrok","sidebarTitle":"ngrok","icon":"globe","href":"/enterprise/docker-compose/ngrok"}]}]},{"group":"Configuration","pages":[{"group":"Authentication (SSO)","icon":"shield-check","pages":[{"title":"SAML SSO","icon":"user-shield","href":"/enterprise/integrations/saml-sso"},{"title":"Authentik","icon":"key","href":"/enterprise/integrations/saml-providers/authentik"}]},{"group":"LLM Gateways","icon":"route","root":{"title":"External LLM Gateways","icon":"network-wired","href":"/enterprise/integrations/external-llm-gateways"},"pages":[{"title":"Azure LLM Gateway","sidebarTitle":"Azure","icon":"https://mintlify.s3.us-west-1.amazonaws.com/allhandsai/enterprise/images/azure-logo.svg","href":"/enterprise/integrations/azure-llm-gateway"},{"title":"AWS Bedrock LLM Gateway","sidebarTitle":"AWS Bedrock","icon":"cloud","href":"/enterprise/integrations/aws-bedrock-llm-gateway"},{"title":"Google LLM Gateway","sidebarTitle":"Google","icon":"google","href":"/enterprise/integrations/google-llm-gateway"}]},{"group":"Custom Sandbox Images","icon":"box","root":{"title":"Custom Sandbox Images","icon":"box","href":"/enterprise/custom-sandbox-images/index"},"pages":[{"title":"Building a Custom Sandbox Image","sidebarTitle":"Building Images","icon":"docker","href":"/enterprise/custom-sandbox-images/building-custom-images"},{"title":"Configuring Custom Sandbox Images","sidebarTitle":"Multiple Images","icon":"layer-group","href":"/enterprise/custom-sandbox-images/multiple-images-warm-pools"},{"title":"Single Image via Admin Console","sidebarTitle":"Admin Console","icon":"triangle-exclamation","href":"/enterprise/custom-sandbox-images/single-image-admin-console"},{"title":"Using Custom Images","sidebarTitle":"Using Images","icon":"play","href":"/enterprise/custom-sandbox-images/using-custom-images"}]},{"title":"Running Docker in the Agent Sandbox","sidebarTitle":"Docker in the Sandbox","icon":"docker","href":"/enterprise/docker-in-sandbox"},{"title":"External PostgreSQL","icon":"database","href":"/enterprise/external-postgres"},{"group":"Observability","icon":"chart-line","pages":[{"title":"Analytics","icon":"rocket","href":"/enterprise/analytics"},{"title":"External Observability Platforms","sidebarTitle":"External Platforms","icon":"chart-line","href":"/enterprise/integrations/observability-platforms"}]}]},{"group":"Integrations","pages":[{"title":"Integrations Overview","sidebarTitle":"Overview","icon":"puzzle-piece","href":"/enterprise/integrations/overview"},{"group":"Source Control","icon":"code-branch","pages":[{"title":"GitHub","icon":"github","href":"/enterprise/integrations/github"},{"title":"GitLab","icon":"code-branch","href":"/enterprise/integrations/gitlab"},{"title":"Azure DevOps","icon":"code-branch","href":"/enterprise/integrations/azure-devops"},{"title":"Bitbucket Data Center","icon":"code-branch","href":"/enterprise/integrations/bitbucket-data-center"}]},{"group":"Project Management","icon":"list-check","pages":[{"title":"Jira Cloud","icon":"cloud","href":"/enterprise/integrations/jira-cloud"},{"title":"Jira Data Center","icon":"building","href":"/enterprise/integrations/jira-data-center"}]},{"title":"Slack","icon":"slack","href":"/enterprise/integrations/slack"}]},{"group":"Features","pages":[{"title":"Conversations And Sandboxes","sidebarTitle":"Conversations","icon":"boxes-stacked","href":"/enterprise/conversations-and-sandboxes"},{"group":"Automations","icon":"bolt","root":{"title":"Automations","icon":"bolt","href":"/enterprise/automations"},"pages":[{"title":"GitHub Event Automations","icon":"github","href":"/enterprise/automations/github-events"}]},{"title":"Secrets Management","icon":"key","href":"/enterprise/secrets-management"},{"title":"Skills and Plugins","icon":"puzzle-piece","href":"/enterprise/skills-and-plugins"},{"title":"Plugin Marketplace","icon":"store","href":"/enterprise/plugin-marketplace"},{"group":"Organizations","icon":"building","pages":[{"title":"Organizations Overview","sidebarTitle":"Overview","href":"/openhands/usage/cloud/organizations/overview"},{"title":"Configuring Organizations","sidebarTitle":"Configuration","href":"/openhands/usage/cloud/organizations/configuring-organizations"},{"title":"Managing Members","sidebarTitle":"Members","href":"/openhands/usage/cloud/organizations/managing-members"},{"title":"Roles and Permissions","href":"/openhands/usage/cloud/organizations/roles-permissions"},{"title":"Organization Settings","sidebarTitle":"Settings","href":"/openhands/usage/cloud/organizations/settings"},{"title":"Budgets and Usage","sidebarTitle":"Budgets and Usage","href":"/openhands/usage/cloud/organizations/budgets"}]}]},{"group":"Administration","pages":[{"title":"Troubleshooting","icon":"life-ring","href":"/enterprise/troubleshooting"},{"group":"Release Notes","icon":"rocket","pages":[{"title":"OpenHands Enterprise 0.90.1","href":"/enterprise/release-notes/0.90.1"},{"title":"OpenHands Enterprise 0.81.0","href":"/enterprise/release-notes/0.81.0"},{"title":"OpenHands Enterprise 0.76.0","href":"/enterprise/release-notes/0.76.0"},{"title":"OpenHands Enterprise 0.74.0","href":"/enterprise/release-notes/0.74.0"},{"title":"OpenHands Enterprise 0.71.1","href":"/enterprise/release-notes/0.71.1"},{"title":"OpenHands Enterprise 0.70.0","href":"/enterprise/release-notes/0.70.0"},{"title":"OpenHands Enterprise 0.64.0","href":"/enterprise/release-notes/0.64.0"},{"title":"OpenHands Enterprise 0.55.0","href":"/enterprise/release-notes/0.55.0"},{"title":"OpenHands Enterprise 0.45.0","href":"/enterprise/release-notes/0.45.0"},{"title":"OpenHands Enterprise 0.41.0","href":"/enterprise/release-notes/0.41.0"},{"title":"OpenHands Enterprise 0.36.1","href":"/enterprise/release-notes/0.36.1"},{"title":"OpenHands Enterprise 0.36.0","href":"/enterprise/release-notes/0.36.0"},{"title":"OpenHands Enterprise 0.28.0","href":"/enterprise/release-notes/0.28.0"},{"title":"OpenHands Enterprise 0.24.0","href":"/enterprise/release-notes/0.24.0"}]}]}]},{"tab":"Enterprise Cookbook","groups":[{"group":"Overview","pages":[{"title":"Enterprise Cookbook","href":"/cookbook"}]},{"group":"Sandbox lifecycle","pages":[{"title":"Archive Sandbox","icon":"box-archive","href":"/cookbook/archive-sandbox"},{"title":"Clone and Attach","icon":"code-branch","href":"/cookbook/clone-and-attach"},{"title":"Start Sandbox","icon":"play","href":"/cookbook/start-sandbox"},{"title":"Warm Sandbox Pool","icon":"fire","href":"/cookbook/warm-sandbox-pool"}]},{"group":"Conversation monitoring \u0026 reacting","pages":[{"title":"Conversation Metrics","icon":"chart-line","href":"/cookbook/conversation-metrics"},{"title":"Conversation Tags","icon":"tags","href":"/cookbook/conversation-tags"},{"title":"Finish Callback","icon":"bell","href":"/cookbook/finish-callback"},{"title":"React to State WebSocket","icon":"bolt","href":"/cookbook/react-to-state-websocket"},{"title":"Server Info Idle","icon":"clock","href":"/cookbook/server-info-idle"},{"title":"Watch Terminal State","icon":"terminal","href":"/cookbook/watch-terminal-state"}]},{"group":"Secrets \u0026 authentication","pages":[{"title":"AWS Secrets Sync","icon":"key","href":"/cookbook/aws-secrets-sync"},{"title":"GPG Commit Signing","icon":"file-signature","href":"/cookbook/gpg-commit-signing"},{"title":"Per-Conversation Secrets","icon":"user-secret","href":"/cookbook/per-conversation-secrets"},{"title":"Service Account GitHub PAT","icon":"id-card","href":"/cookbook/service-account-github-pat"}]},{"group":"Onboarding \u0026 org admin","pages":[{"title":"Super Admins and Organizations","icon":"user-shield","href":"/cookbook/org-admin"},{"title":"Provision Users","icon":"users-gear","href":"/cookbook/provision-users"}]},{"group":"Plugins, skills \u0026 MCP","pages":[{"title":"Launch Plugin Badge","icon":"rocket","href":"/cookbook/launch-plugin-badge"},{"title":"Load Plugin","icon":"plug","href":"/cookbook/load-plugin"},{"title":"Plugin With Script","icon":"file-code","href":"/cookbook/plugin-with-script"},{"title":"Test MCP Config","icon":"vial","href":"/cookbook/test-mcp-config"},{"title":"Upload Skills","icon":"upload","href":"/cookbook/upload-skills"}]},{"group":"Custom agents \u0026 tools","pages":[{"title":"Custom Agent No Browser","icon":"sliders","href":"/cookbook/custom-agent-no-browser"},{"title":"Custom Pip Tool Agent","icon":"box","href":"/cookbook/custom-agent-with-pip-tool"},{"title":"Custom Agent With Tool","icon":"wrench","href":"/cookbook/custom-agent-with-tool"},{"title":"Custom System Prompt","icon":"message","href":"/cookbook/custom-system-prompt"},{"title":"Disabled Skills","icon":"ban","href":"/cookbook/disabled-skills"}]},{"group":"Guardrails","pages":[{"title":"Command Blacklist","icon":"shield-halved","href":"/cookbook/command-blacklist"},{"title":"Command Whitelist","icon":"user-shield","href":"/cookbook/command-whitelist"},{"title":"Workspace Isolation","icon":"folder-tree","href":"/cookbook/workspace-isolation"}]}]}]},"basePath":"","title":"Toad Terminal - OpenHands Docs","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-CAita2ok.js","lightbox-handle-r17bVUz3.js"]}
