Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.
{
"ok": false,
"type": "sandbox.error",
"status": 409,
"code": "provider_not_configured",
"message": "Prompting is locked until Codex is configured on the Agents page.",
"requestId": "req_01HX...",
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
}
}
{
"ok": false,
"type": "sandbox.error",
"status": 409,
"code": "provider_not_configured",
"message": "Prompting is locked until Codex is configured on the Agents page.",
"requestId": "req_01HX...",
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
}
}
{
"ok": false,
"type": "sandbox.error",
"status": 409,
"code": "provider_not_configured",
"message": "Prompting is locked until Codex is configured on the Agents page.",
"requestId": "req_01HX...",
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
}
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"boat","colors":{"primary":"#263FA9","light":"#929FD3","dark":"#263FA9"},"logo":{"light":"https://mintcdn.com/ariana-1e97e6c3/qYEPg6P4ACx7GhnX/logo/light.svg?fit=max\u0026auto=format\u0026n=qYEPg6P4ACx7GhnX\u0026q=85\u0026s=eaa1695372bf1bda281c905925c68573","dark":"https://mintcdn.com/ariana-1e97e6c3/qYEPg6P4ACx7GhnX/logo/dark.svg?fit=max\u0026auto=format\u0026n=qYEPg6P4ACx7GhnX\u0026q=85\u0026s=cbd64207fbbff27ff71b1ef4477f3455"},"favicon":{"light":"https://mintcdn.com/ariana-1e97e6c3/YRKQLhWfx1vmU_pI/favicon.svg?fit=max\u0026auto=format\u0026n=YRKQLhWfx1vmU_pI\u0026q=85\u0026s=c6dcc75b9e5b9bf0c862f0dec353a714","dark":"https://mintcdn.com/ariana-1e97e6c3/YRKQLhWfx1vmU_pI/favicon-dark.svg?fit=max\u0026auto=format\u0026n=YRKQLhWfx1vmU_pI\u0026q=85\u0026s=b4687840a0e61227fb2a642a1c20f6f0"},"api":{"openapi":{"source":"openapi/boat-v1.yaml","directory":"api/reference"},"playground":{"display":"interactive"}},"background":{"color":{"light":"#FEFEFE","dark":"#060606"}},"navbar":{"primary":{"type":"button","label":"Go to Dashboard","href":"https://boat.dev/dashboard?tab=sandboxes"}},"footer":{"socials":{"github":"https://github.com/ariana-dot-dev","discord":"https://discord.gg/Y3TFTmE89g"}},"fonts":{"heading":{"family":"Funnel Display","weight":400},"body":{"family":"Inter","weight":400}},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark-default"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ariana-1e97e6c3","hasAudioNarration":false,"actualSubdomain":"ariana-1e97e6c3","customDomains":["docs.boat.dev"],"gitSource":{"type":"github","owner":"ariana-dot-dev","repo":"ariana-ide-private","deployBranch":"main","contentDirectory":"public-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae6b93ce7a853c3110aa1d8","collectionId":"4c379d7a-3bc6-4bab-8d0e-97c033a7a402","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae6b93ce7a853c3110aa1d8"},"entitlements":{},"buildId":"6ae6b93ce7a853c3110aa1d8","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Reference","count":123},{"language":"default","tag":"Guides","count":79},{"language":"default","tag":"AI credentials","count":17},{"language":"default","tag":"Environments","count":15},{"language":"default","tag":"Files","count":14},{"language":"default","tag":"Use cases","count":14},{"language":"default","tag":"Sandboxes","count":13},{"language":"default","tag":"Platform","count":9},{"language":"default","tag":"Webhooks and OpenTelemetry","count":9},{"language":"default","tag":"Connect to a sandbox","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"/* latin-ext */\n@font-face {\n font-family: 'Funnel Display';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/funneldisplay/v3/B50WF7FGv37QNVWgE0ga--4Pbb6TDYsmgQ.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Funnel Display';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/funneldisplay/v3/B50WF7FGv37QNVWgE0ga--4Pbb6dDYs.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Funnel Display';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/funneldisplay/v3/B50WF7FGv37QNVWgE0ga--4Pbb6TDYsmgQ.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Funnel Display';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/funneldisplay/v3/B50WF7FGv37QNVWgE0ga--4Pbb6dDYs.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iIq129k.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1isq129k.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iAq129k.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1iEq129k.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F63fjptAgt5VM-kVkqdyU8n1i8q1w.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl1FgtIU.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwlRFgtIU.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* vietnamese */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl9FgtIU.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwl5FgtIU.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'IBM Plex Mono';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/ibmplexmono/v20/-F6qfjptAgt5VM-kVkqdyU8n3twJwlBFgg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n:root{--wash:#FEFEFE;--deep:#060606;--ocean:#263FA9;--blue-1:#F1F3F9;--blue-2:#E0E3F2;--blue-3:#C2C9E6;--blue-4:#929FD3;--blue-8:#1E3180;--blue-9:#162358;--blue-10:#0F1634;--n-2:#F2F2F2;--n-3:#E0E0E0;--n-4:#C4C4C4;--n-5:#9E9E9E;--n-6:#767676;--n-7:#4D4D4D;--n-8:#2E2E2E;--n-9:#1A1A1A;--error:#B42318;--error-tint:#FBE9E7;--font-display:\"Funnel Display\", system-ui, sans-serif;--font-text:Inter, system-ui, sans-serif;--font-code:\"IBM Plex Mono\", ui-monospace, monospace;--ease:cubic-bezier(0.37, 0, 0.63, 1);--text:var(--deep);--quiet:var(--n-7);--line:var(--n-3);--raised:var(--n-2);--accent:var(--ocean);--accent-hover:var(--blue-8);--select:var(--blue-1);--select-text:var(--ocean);--rounded-sm:0px;--rounded:0px;--rounded-md:0px;--rounded-lg:0px;--rounded-xl:0px;--rounded-2xl:0px;--rounded-3xl:0px;--gray-50:242 242 242;--gray-100:224 224 224;--gray-200:224 224 224;--gray-300:196 196 196;--gray-400:118 118 118;--gray-500:77 77 77;--gray-600:77 77 77;--gray-700:46 46 46;--gray-800:26 26 26;--gray-900:6 6 6;--gray-950:6 6 6}html.dark{--text:var(--wash);--quiet:var(--n-4);--line:var(--n-8);--raised:var(--n-9);--accent:var(--blue-4);--accent-hover:var(--wash);--select:var(--blue-10);--select-text:var(--blue-4);--gray-200:254 254 254;--gray-300:196 196 196;--gray-400:196 196 196}*,::after,::before{box-shadow:none!important;text-shadow:none!important;backdrop-filter:none!important;-webkit-backdrop-filter:none!important;border-radius:0!important}.rounded-full:is([class*=\"size-1\"], [class*=\"size-2\"], [class*=\"w-1\"], [class*=\"w-2\"]),img.rounded-full{border-radius:9999px!important}body,html{font-family:var(--font-text);letter-spacing:0}body{background-color:var(--wash);color:var(--text)}html.dark body{background-color:var(--deep)}.callout :is(p, li),.card :is(p, span),.mdx-content,.mdx-content :is(p, li, blockquote, td),[data-as=p]{font-size:16px;line-height:140%}#footer,#footer *,#navbar a,#navbar button,#pagination,#pagination *,#sidebar,#sidebar *,#table-of-contents,#table-of-contents *,.nav-tabs,.nav-tabs *{font-family:var(--font-text);letter-spacing:0}.font-mono,.method-nav-pill>span,.method-pill,code,code *,kbd,pre,pre *,samp{font-family:var(--font-code)!important;letter-spacing:0!important}.mdx-content code:not(pre code){font-size:14px!important;background-color:var(--raised)!important;border:0!important;padding:2px 8px!important;color:inherit!important;font-weight:400!important}b,strong,th{font-weight:500!important}em,i{font-style:normal!important;font-weight:500}table{font-variant-numeric:tabular-nums}#page-title,header h1{font-family:var(--font-display)!important;font-size:clamp(32px,28px + 1vw,40px)!important;line-height:110%!important;letter-spacing:-.02em!important;font-weight:400!important;color:var(--text)!important}.mdx-content h2:not([data-component-part]),.mdx-content h2:not([data-component-part]) *{font-family:var(--font-display)!important;font-size:24px!important;line-height:120%!important;letter-spacing:-.02em!important;font-weight:400!important;color:var(--text)!important}.mdx-content :is(h3, h4),.mdx-content :is(h3, h4) *{font-family:var(--font-text)!important;font-size:16px!important;line-height:140%!important;letter-spacing:0!important;font-weight:500!important;color:var(--text)!important}#content-area header p,header #page-title~p{font-size:16px!important;line-height:140%!important;color:var(--quiet)!important}.eyebrow{color:var(--accent)!important;font-weight:500!important}.mdx-content>:is(p, ul, ol, table, .code-block, .code-group, .callout, .columns, .card-group, .steps, .frame, img, div),.mdx-content>[data-as=p]{margin-top:0!important;margin-bottom:24px!important}.callout [data-as=p]:last-child,.card [data-as=p]{margin:0!important}.mdx-content>:last-child{margin-bottom:0!important}.mdx-content>h2{margin-top:48px!important;margin-bottom:16px!important}.mdx-content>h2:first-child{margin-top:0!important}.mdx-content>:is(h3, h4){margin-top:32px!important;margin-bottom:8px!important}.mdx-content>hr{margin:48px 0!important;border-color:var(--line)!important}.mdx-content>hr+:is(h2, h3, h4){margin-top:0!important}.mdx-content li+li{margin-top:8px!important}.mdx-content li>p{margin:0!important}.mdx-content table{border:1px solid var(--line)!important;border-collapse:collapse!important;width:100%}.mdx-content table :is(th, td){padding:12px 16px!important;vertical-align:top;border-color:var(--line)!important}.mdx-content table thead :is(th, td){background-color:var(--raised)!important;border-bottom:1px solid var(--line)!important}#pagination [data-component-part],#pagination a:hover *,.mdx-content table th{color:var(--text)!important}#search-bar-entry *,.api-section *,.field *,.method-nav-pill>span,.method-pill,[class*=\"text-[0.\"],[class*=text-xs],[data-component-part=code-group-tab-bar] *,[role=menu] *{font-size:14px!important;line-height:140%!important}pre code,pre code *{font-size:14px!important}.method-nav-pill>span,.method-pill{padding:0 8px!important}.method-nav-pill{width:64px!important;min-width:64px!important;flex:none!important;margin-right:8px!important}.method-nav-pill>span{display:inline-block;width:auto}#page-context-menu-button,#page-context-menu-button+button,#pagination *{color:var(--quiet)!important}#pagination nav,nav[class*=bg-gray-50]{background-color:transparent!important}b,strong{color:inherit!important}.code-block-background,.code-block-background *,[data-component-part=code-block-root]{border-radius:0!important}[class*=bg-neutral-300][class*=rounded-full]{background-color:transparent!important;transition:background-color 120ms var(--ease)}:hover>*>[class*=bg-neutral-300][class*=rounded-full],:hover>[class*=bg-neutral-300][class*=rounded-full],[data-scrolling] [class*=bg-neutral-300][class*=rounded-full]{background-color:var(--n-4)!important}html.dark :hover>*>[class*=bg-neutral-300][class*=rounded-full]{background-color:var(--n-8)!important}.mdx-content a:not(.card):not([class*=card]):not(:has(>img)){color:var(--accent)!important;text-decoration:underline!important;text-decoration-thickness:1px!important;text-underline-offset:4px!important;border-bottom:0!important;font-weight:inherit!important;transition:color 120ms var(--ease)}.mdx-content a:not(.card):not([class*=card]):hover{color:var(--accent-hover)!important}:focus-visible{outline:2px solid var(--accent)!important;outline-offset:2px!important}#content>p,.mdx-content :is(p, li, td, blockquote),[data-as=p]{color:var(--text)!important}img.nav-logo{padding:0!important;max-width:none!important}@media (min-width:1024px){img.nav-logo{height:48px!important}div:has(>a>img.nav-logo){flex-wrap:wrap!important;row-gap:24px}div:has(>a>img.nav-logo)>a{flex-basis:100%}}@media (max-width:1023px){img.nav-logo{height:32px!important;content:url(/favicon.svg)}html.dark img.nav-logo{content:url(/favicon-dark.svg)}}#page-context-menu-button svg,#search-bar-entry svg,#sidebar a[href*=dashboard] svg,.theme-preference-switch-option svg,[data-component-part=code-group-tab-bar] button[aria-label*=opy i] svg,[data-floating-buttons] button svg{width:24px!important;height:24px!important;flex:none;background-color:currentColor!important;-webkit-mask:var(--px) center/24px 24px no-repeat!important;mask:var(--px) center/24px 24px no-repeat!important}:is(#footer a[href*=\"github.com\"], #footer a[href*=\"discord\"]) svg *,:is(.theme-preference-switch-option, #search-bar-entry, [data-floating-buttons] button, #page-context-menu-button, #sidebar a[href*=\"dashboard\"]) svg *{visibility:hidden}[data-component-part=code-group-tab-bar] button[aria-label*=opy i] svg *{visibility:hidden}.theme-preference-switch-option[aria-label*=system i] svg{--px:url(\"/images/icons/monitor.svg\")}.theme-preference-switch-option[aria-label*=light i] svg{--px:url(\"/images/icons/sun.svg\")}.theme-preference-switch-option[aria-label*=dark i] svg{--px:url(\"/images/icons/moon.svg\")}#search-bar-entry svg{--px:url(\"/images/icons/search.svg\")}#page-context-menu-button svg,[data-component-part=code-group-tab-bar] button[aria-label*=opy i] svg,[data-floating-buttons] button svg{--px:url(\"/images/icons/copy.svg\")}#sidebar a[href*=dashboard] svg{--px:url(\"/images/icons/external-link.svg\")}#footer a[href*=\"github.com\"] svg,#footer a[href*=discord] svg{width:24px!important;height:24px!important;flex:none;background-color:currentColor!important;-webkit-mask:var(--px) center/24px 24px no-repeat!important;mask:var(--px) center/24px 24px no-repeat!important}#footer a[href*=\"github.com\"] svg{--px:url(\"/images/icons/github.svg\")}#footer a[href*=discord] svg{--px:url(\"/images/icons/discord.svg\")}.theme-preference-switch-option{width:32px!important;height:32px!important}[data-theme-preference-switch],div:has(>.theme-preference-switch-option){height:auto!important;width:auto!important;gap:4px!important;padding:4px!important}#navbar [class*=border-b],#navbar-transition,[data-theme-preference-switch]{border-color:var(--line)!important}.theme-preference-switch-option{background-color:transparent!important;color:var(--quiet)!important}.theme-preference-switch-option[aria-pressed=true]{background-color:var(--select)!important;color:var(--select-text)!important}#topbar-cta-button a{background-color:var(--ocean)!important;border:0!important}#topbar-cta-button a,#topbar-cta-button a *{color:var(--wash)!important}#topbar-cta-button a:hover{background-color:var(--blue-8)!important}#search-bar-entry{border:1px solid var(--line)!important;background-color:transparent!important;height:48px!important;padding:0 16px!important}#sidebar [data-active]>a,#sidebar a[data-active],li>a[aria-current=page]{background-color:var(--select)!important;color:var(--select-text)!important;font-weight:500!important}#sidebar a[data-active] *,li>a[aria-current=page] *{color:var(--select-text)!important}#sidebar a,#sidebar button{color:var(--quiet)}.sidebar-group-header,.sidebar-group-header *{color:var(--text)!important;font-weight:500!important}#table-of-contents a,.nav-tabs-item{color:var(--quiet)!important}#table-of-contents [data-active] a,#table-of-contents a[data-active]{color:var(--accent)!important}.nav-tabs-item[aria-current=page],.nav-tabs-item[data-active],[data-component-part=code-group-tab-bar] button[data-active]{color:var(--text)!important}.nav-tabs-item [class*=bg-primary],.nav-tabs-item[data-active]>div:last-child{background-color:var(--accent)!important}.code-block,.code-group{border:1px solid var(--line)!important}.accordion summary:hover,.code-block,.code-block pre,.code-group,.code-group pre,pre.shiki{background-color:var(--raised)!important}.code-block-background,.code-block>div div,.code-block>div:not([data-floating-buttons]),.code-group>div:not([data-component-part=code-group-tab-bar]),.code-group>div:not([data-component-part=code-group-tab-bar]) div{background-color:transparent!important;border-color:transparent!important}[data-component-part=code-group-tab-bar]{border-bottom:1px solid var(--line)!important;background-color:var(--raised)!important}[data-component-part=code-group-tab-bar] button{color:var(--quiet)!important;background-color:transparent!important;height:48px!important;padding:0!important;margin:0 24px 0 0!important}.code-block [class*=bg-gradient],.code-group [class*=bg-gradient],[data-fade-overlay]{display:none!important}pre,pre *{font-size:14px!important;line-height:160%!important}.code-block[data-has-floating-buttons]{position:relative}.code-block[data-has-floating-buttons]::after{content:\"\";position:absolute;top:1px;right:0;bottom:1px;width:48px;background-color:var(--raised);pointer-events:none;z-index:5}.code-block [data-floating-buttons]{z-index:10!important}.code-block[data-has-floating-buttons] [data-component-part=scroll-area-viewport]{padding-right:48px!important}:is(.code-block, .code-group) pre>code{display:inline-block;min-width:100%;padding-right:16px!important}:is(.code-block, .code-group) [data-component-part=scroll-area-viewport]{width:auto!important;margin-right:16px!important}[data-component-part=code-group-tab-bar]{min-height:48px;padding-left:6px!important;padding-right:16px!important}[data-component-part=code-group-tab-bar] button>.absolute{bottom:0!important;height:2px!important}html.dark :is(.code-block, .code-group) .code-block-background{background-color:var(--raised)!important}.code-group,[data-component-part=code-group-tab-bar] button>div{padding:0!important}@media (max-width:767px){[data-component-part=code-group-tab-bar] button{margin-right:16px!important}}:is(pre, code, .font-mono) span:is([style*=\"rgb(36, 41, 46)\"], [style*=\"rgb(34, 134, 58)\"], [style*=\"color:#24292E\" i], [style*=\"color:#22863A\" i]),pre.shiki{color:var(--deep)!important}:is(pre, code, .font-mono) span:is([style*=\"rgb(111, 66, 193)\"], [style*=\"rgb(0, 92, 197)\"], [style*=\"color:#6F42C1\" i], [style*=\"color:#005CC5\" i]){color:var(--ocean)!important}:is(pre, code, .font-mono) span:is([style*=\"rgb(215, 58, 73)\"], [style*=\"color:#D73A49\" i]){color:var(--blue-8)!important}:is(pre, code, .font-mono) span:is([style*=\"rgb(3, 47, 98)\"], [style*=\"rgb(227, 98, 9)\"], [style*=\"color:#032F62\" i], [style*=\"color:#E36209\" i]){color:var(--blue-9)!important}:is(pre, code, .font-mono) span:is([style*=\"rgb(106, 115, 125)\"], [style*=\"color:#6A737D\" i]){color:var(--n-7)!important}html.dark :is(pre, code, .font-mono) span[style],html.dark pre.shiki{color:var(--wash)!important}html.dark :is(pre, code, .font-mono) span:is([style*=\"#FFA657\" i], [style*=\"#D2A8FF\" i], [style*=\"#FF7B72\" i], [style*=\"#79C0FF\" i], [style*=\"#8B949E\" i]){color:var(--blue-4)!important}.card{margin:0!important}.card-group,.columns{gap:16px!important;grid-auto-rows:auto!important}[data-component-part=card-content-container]{padding:24px!important}.card [data-component-part=card-title]{margin-top:0!important;font-family:var(--font-text)!important;line-height:140%!important;letter-spacing:0!important}.card [data-component-part=card-content]{margin-top:4px!important}.card [data-component-part=card-content] :is(p, ul, ol){margin:0!important}.card{border:1px solid var(--line)!important;background-color:transparent!important;transition:border-color 120ms var(--ease)}#pagination a:hover,.card:hover{border-color:var(--accent)!important}.card [data-component-part=card-title]{font-size:16px!important;font-weight:500!important;color:var(--text)!important}.card [data-component-part=card-content],.card [data-component-part=card-content] *,.card p{color:var(--quiet)!important}[data-component-part=card-icon]:has(img[src^=\"/images/icons/\"]){width:24px!important;height:24px!important;-webkit-mask:var(--icon) center/24px 24px no-repeat;mask:var(--icon) center/24px 24px no-repeat;background-color:var(--accent)!important}[data-component-part=card-icon] img[src^=\"/images/icons/\"]{visibility:hidden}.card [data-component-part=card-icon] svg{width:24px!important;height:24px!important;background-color:var(--accent)!important}.card [data-component-part=card-icon]{margin-bottom:16px!important}.param-head [class*=text-primary]{color:var(--text)!important;font-weight:500!important}.api-section [class*=text-red],.field [class*=red]{background-color:var(--raised)!important;color:var(--text)!important}.callout{--c-base:var(--ocean);--c-tint:var(--blue-1);border:1px solid var(--c-base)!important;background-color:var(--c-tint)!important}.callout[data-callout-type=warning]{--c-base:#8A5300;--c-tint:#FBF1DE}.callout:is([data-callout-type=\"danger\"], [data-callout-type=\"error\"]){--c-base:#B42318;--c-tint:#FBE9E7}.callout:is([data-callout-type=\"check\"], [data-callout-type=\"success\"], [data-callout-type=\"tip\"]){--c-base:#1D6F48;--c-tint:#E8F3ED}.callout *{color:var(--deep)!important}.callout svg,.callout svg *{color:var(--c-base)!important}html.dark .callout{--c-tint:var(--deep)}html.dark .callout *{color:var(--wash)!important}html.dark .callout:is([data-callout-type=\"info\"], [data-callout-type=\"note\"], :not([data-callout-type])){--c-base:var(--blue-4);--c-tint:var(--blue-10)}#footer,#pagination a,.accordion,.accordion-group{border-color:var(--line)!important}[data-component-part=accordion-button]{padding:16px 24px!important;gap:12px!important;align-items:flex-start!important}[data-component-part=accordion-caret-right]{height:22px!important}[data-component-part=accordion-content]{padding:0 24px 16px 52px!important}[data-component-part=accordion-content]>:last-child{margin-bottom:0!important}.step [class*=w-px],.steps [class*=border-l],.steps [class*=w-px]{background-color:var(--line)!important;border-color:var(--line)!important}[data-component-part=step-number]{background-color:transparent!important}[data-component-part=step-indicator]{width:32px!important;height:32px!important;background-color:var(--wash)!important;border:1px solid var(--line)!important;color:var(--text)!important}html.dark [data-component-part=step-indicator]{background-color:var(--deep)!important}[data-component-part=step-indicator] *{font-family:var(--font-code)!important;font-size:14px!important;color:inherit!important}[data-component-part=step-title]{font-weight:500!important;color:var(--text)!important}[data-component-part=step-content]>*{margin-top:0!important;margin-bottom:16px!important}[data-component-part=step-content]>:last-child{margin-bottom:0!important}#footer a{color:var(--quiet)!important}#footer a:hover{color:var(--accent)!important}html:not(.dark) #footer{padding-bottom:336px!important;background-image:url(/images/brand/mosaic-sloop.svg)!important;background-repeat:no-repeat!important;background-size:624px 576px!important;background-position:right 0 bottom -288px!important}@media (max-width:767px){html:not(.dark) #footer{padding-bottom:216px!important;background-size:364px 336px!important;background-position:center bottom -168px!important}}.method-nav-pill>span,.method-pill{background-color:var(--raised)!important;color:var(--text)!important;font-weight:500!important}:is(.method-nav-pill > span, .method-pill):is([class*=\"blue\"], [class*=\"3064E3\"]){background-color:var(--blue-1)!important;color:var(--ocean)!important}:is(.method-nav-pill > span, .method-pill):is([class*=\"orange\"], [class*=\"yellow\"], [class*=\"amber\"]){background-color:var(--blue-2)!important;color:var(--deep)!important}:is(.method-nav-pill > span, .method-pill)[class*=red]{background-color:var(--error-tint)!important;color:var(--error)!important}html.dark :is(.method-nav-pill > span, .method-pill){background-color:var(--n-9)!important;color:var(--wash)!important}html.dark :is(.method-nav-pill > span, .method-pill):is([class*=\"blue\"], [class*=\"3064E3\"]){background-color:var(--blue-10)!important;color:var(--blue-4)!important}div:has(>div>button.tryit-button){border:0!important;padding:0!important;background-color:transparent!important}div:has(>button.tryit-button)>*+*{margin-left:8px!important}div:has(>.method-pill):has(~button.tryit-button){height:48px!important;padding:0 48px 0 0!important;gap:16px!important;border:1px solid var(--line)!important;align-items:center!important}div:has(>.method-pill):has(~button.tryit-button)>.method-pill{align-self:stretch!important;display:flex!important;align-items:center!important;padding:0 16px!important}div:has(>.method-pill):has(~button.tryit-button)>button{right:12px!important}.tryit-button{height:48px!important;padding:0 24px!important;background-color:var(--ocean)!important;color:var(--wash)!important}#sidebar .method-nav-pill>span{background-color:transparent!important;padding:0!important}#sidebar .method-nav-pill>span:is([class*=\"blue\"], [class*=\"3064E3\"]){color:var(--accent)!important}.tryit-button:hover{background-color:var(--blue-8)!important}[class*=text-stone]{color:var(--quiet)!important}[class*=bg-stone]{background-color:var(--raised)!important}.bg-white{background-color:var(--wash)!important}html.dark .bg-white,html.dark [class*=\"group-hover/mermaid\"].grid button{background-color:var(--deep)!important}.fixed.inset-0:is([class*=\"bg-black\"], [class*=\"bg-gray\"]){background-color:rgb(6 6 6/.6)!important}.mermaid,.mermaid :is(text, tspan, span, div, p, foreignObject *){font-family:var(--font-code)!important;font-size:14px!important;font-weight:400!important;line-height:140%!important}html.dark .mermaid :is(text, tspan),html.dark .mermaid text.actor>tspan{fill:var(--wash)!important}.mermaid svg{padding:16px;box-sizing:border-box}[class*=\"group-hover/mermaid\"].grid{gap:8px!important}[class*=\"group-hover/mermaid\"].grid button{width:32px!important;height:32px!important;border:1px solid var(--line)!important;background-color:var(--wash)!important;color:var(--text)!important}.mermaid .actor,.mermaid .labelBox,.mermaid .node circle,.mermaid .node path:not(.flowchart-link),.mermaid .node polygon,.mermaid .node rect,.mermaid .note,.mermaid rect.activation0,.mermaid rect.activation1,.mermaid rect.activation2{fill:var(--blue-1)!important;stroke:var(--ocean)!important;rx:0!important;ry:0!important}.mermaid .cluster rect{fill:var(--wash)!important;stroke:var(--n-4)!important;rx:0!important;ry:0!important}html.dark .mermaid .cluster rect{fill:var(--deep)!important;stroke:var(--n-8)!important}.mermaid .cluster-label,.mermaid .cluster-label *{color:var(--quiet)!important;fill:var(--quiet)!important}.mermaid .actor-line,.mermaid .edgePath path,.mermaid .flowchart-link,.mermaid .loopLine,.mermaid .messageLine0,.mermaid .messageLine1,.mermaid .transition{stroke:var(--deep)!important}.mermaid .arrowheadPath,.mermaid marker path{fill:var(--deep)!important;stroke:var(--deep)!important}.mermaid .edgeLabel,.mermaid .nodeLabel,.mermaid span,.mermaid text{fill:var(--deep)!important;color:var(--deep)!important;stroke:none!important}.mermaid .edgeLabel,.mermaid .edgeLabel *{background-color:var(--wash)!important}html.dark .mermaid :is(.actor, .labelBox, .note, rect.activation0, rect.activation1, rect.activation2, .node rect, .node polygon, .node circle, .node path:not(.flowchart-link)){fill:var(--blue-10)!important;stroke:var(--blue-4)!important}html.dark .mermaid :is(.actor-line, .messageLine0, .messageLine1, .loopLine, .flowchart-link, .edgePath path, .transition){stroke:var(--wash)!important}html.dark .mermaid :is(.arrowheadPath, marker path){fill:var(--wash)!important;stroke:var(--wash)!important}html.dark .mermaid :is(text, .nodeLabel, .edgeLabel, span){fill:var(--wash)!important;color:var(--wash)!important}html.dark .mermaid .edgeLabel,html.dark .mermaid .edgeLabel *{background-color:var(--deep)!important}a,button{transition-timing-function:var(--ease)!important}@media (prefers-reduced-motion:reduce){*,::after,::before{transition-duration:120ms!important;animation:none!important}}[data-component-part=card-icon]:has(img[src=\"/images/icons/archive.svg\"]){--icon:url(\"/images/icons/archive.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/arrow-right.svg\"]){--icon:url(\"/images/icons/arrow-right.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/arrows-out.svg\"]){--icon:url(\"/images/icons/arrows-out.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/bolt.svg\"]){--icon:url(\"/images/icons/bolt.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/book.svg\"]){--icon:url(\"/images/icons/book.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/brackets-curly.svg\"]){--icon:url(\"/images/icons/brackets-curly.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/check.svg\"]){--icon:url(\"/images/icons/check.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/clock.svg\"]){--icon:url(\"/images/icons/clock.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/clone.svg\"]){--icon:url(\"/images/icons/clone.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/comments.svg\"]){--icon:url(\"/images/icons/comments.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/credit-card.svg\"]){--icon:url(\"/images/icons/credit-card.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/desktop.svg\"]){--icon:url(\"/images/icons/desktop.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/diagram.svg\"]){--icon:url(\"/images/icons/diagram.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/download.svg\"]){--icon:url(\"/images/icons/download.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/eye-off.svg\"]){--icon:url(\"/images/icons/eye-off.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/flask.svg\"]){--icon:url(\"/images/icons/flask.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/gauge.svg\"]){--icon:url(\"/images/icons/gauge.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/git-branch.svg\"]){--icon:url(\"/images/icons/git-branch.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/git-fork.svg\"]){--icon:url(\"/images/icons/git-fork.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/globe.svg\"]){--icon:url(\"/images/icons/globe.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/hand-pointer.svg\"]){--icon:url(\"/images/icons/hand-pointer.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/hard-drive.svg\"]){--icon:url(\"/images/icons/hard-drive.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/history.svg\"]){--icon:url(\"/images/icons/history.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/image.svg\"]){--icon:url(\"/images/icons/image.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/key.svg\"]){--icon:url(\"/images/icons/key.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/layer-group.svg\"]){--icon:url(\"/images/icons/layer-group.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/list-check.svg\"]){--icon:url(\"/images/icons/list-check.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/lock.svg\"]){--icon:url(\"/images/icons/lock.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/microchip.svg\"]){--icon:url(\"/images/icons/microchip.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/network.svg\"]){--icon:url(\"/images/icons/network.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/play.svg\"]){--icon:url(\"/images/icons/play.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/refresh.svg\"]){--icon:url(\"/images/icons/refresh.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/robot.svg\"]){--icon:url(\"/images/icons/robot.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/rocket.svg\"]){--icon:url(\"/images/icons/rocket.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/server.svg\"]){--icon:url(\"/images/icons/server.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/shield.svg\"]){--icon:url(\"/images/icons/shield.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/shield-check.svg\"]){--icon:url(\"/images/icons/shield-check.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/signal.svg\"]){--icon:url(\"/images/icons/signal.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/signpost.svg\"]){--icon:url(\"/images/icons/signpost.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/sliders.svg\"]){--icon:url(\"/images/icons/sliders.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/sparkle.svg\"]){--icon:url(\"/images/icons/sparkle.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/stop.svg\"]){--icon:url(\"/images/icons/stop.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/table.svg\"]){--icon:url(\"/images/icons/table.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/tag.svg\"]){--icon:url(\"/images/icons/tag.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/terminal.svg\"]){--icon:url(\"/images/icons/terminal.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/toolbox.svg\"]){--icon:url(\"/images/icons/toolbox.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/trash.svg\"]){--icon:url(\"/images/icons/trash.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/user.svg\"]){--icon:url(\"/images/icons/user.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/users.svg\"]){--icon:url(\"/images/icons/users.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/wallet.svg\"]){--icon:url(\"/images/icons/wallet.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/wrench.svg\"]){--icon:url(\"/images/icons/wrench.svg\")}[data-component-part=card-icon]:has(img[src=\"/images/icons/x.svg\"]){--icon:url(\"/images/icons/x.svg\")}"}],"page":{"pagePath":"api/reference/agent/interrupt-running-agent-work","slug":"/api/reference/agent/interrupt-running-agent-work","pageMetadata":{"title":"Interrupt running work","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/interrupt","description":"Interrupt running agent work. By default this stops **every** conversation on the sandbox. Pass `conversation` to stop just one, leaving the others running. See [Integrated agents](/integrated-agents).","href":"/api/reference/agent/interrupt-running-agent-work"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Interrupt running agent work. By default this stops \", _jsx(_components.strong, {\n children: \"every\"\n }), \" conversation on the sandbox. Pass \", _jsx(_components.code, {\n children: \"conversation\"\n }), \" to stop just one, leaving the others running. See \", _jsx(_components.a, {\n href: \"/integrated-agents\",\n children: \"Integrated agents\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark-default"}},"config":{},"pageMetadata":{"title":"Interrupt running work","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/interrupt","description":"Interrupt running agent work. By default this stops **every** conversation on the sandbox. Pass `conversation` to stop just one, leaving the others running. See [Integrated agents](/integrated-agents).","href":"/api/reference/agent/interrupt-running-agent-work"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ariana-1e97e6c3/a7a23abe3f9d2f7b/old-section-links.js"],"openApiReferenceData":{"operation":{"tags":["Boat"],"summary":"Interrupt running work","description":"Interrupt running agent work. By default this stops **every** conversation on the sandbox. Pass `conversation` to stop just one, leaving the others running. See [Integrated agents](/integrated-agents).","operationId":"interrupt","parameters":["646a0239-3432-489b-b326-9126fa522e4c","9294ea11-4b3e-4799-b314-4ac95ed316b3"],"responses":{"200":"fd2c394b-4a9e-49b6-93d4-234182ec6b58","401":"145d39ec-f159-49f1-8de6-00f4c78eddd0","402":"1bbcc98b-8ed0-47d1-b7b0-6078400df533","404":"7f823c9b-d045-440d-952b-23641b19cd3f","409":"411daa6d-3fc4-4f7f-a54f-eb51c9cfe8af"},"method":"post","type":"path","servers":["eb19bdfe-1d1c-4f2b-9f80-620e450766ba"],"security":["3164fa28-cf6f-4842-8803-d0c669b5bec3"],"path":"/sandboxes/{sandboxId}/interrupt","baseUrlOptions":["https://boat.dev/api/v1"],"title":"Interrupt running work","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"646a0239-3432-489b-b326-9126fa522e4c":{"name":"sandboxId","in":"path","required":true,"schema":{"type":"string","pattern":"^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$","isRequired":true,"description":"Public Sandbox id returned by create/list/get sandbox calls.","uniqueKey":"","typeLabel":"string"},"description":"Public Sandbox id returned by create/list/get sandbox calls."},"9294ea11-4b3e-4799-b314-4ac95ed316b3":{"name":"conversation","in":"query","schema":{"type":"string","description":"Interrupt only this conversation id. Omit to interrupt the whole sandbox.","uniqueKey":"","typeLabel":"string"},"description":"Interrupt only this conversation id. Omit to interrupt the whole sandbox."}},"responses":{"fd2c394b-4a9e-49b6-93d4-234182ec6b58":{"description":"Interrupt requested.","content":{"application/json":{"schema":{"type":"object","required":["id","status","ok","type"],"properties":{"ok":{"type":"boolean","examples":[true],"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"type":{"type":"string","description":"Stable success envelope discriminator added by v1.","example":"sandbox.stopping","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","examples":["archiving"],"isRequired":true,"uniqueKey":"status","typeLabel":"string"},"sandbox":{"oneOf":[{"type":"object","required":["id","name","state","desktopAvailable","snapshotAvailable"],"properties":{"id":{"type":"string","pattern":"^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$","examples":["bx_23456789"],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","examples":["Boat 2026-05-31 12:00"],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.name","typeLabel":"string"},"state":{"type":"string","enum":["init","provisioning","provisioned","cloning","ready","idle","running","archiving","archived","error","cancelled"],"description":"`cancelled` is terminal: a create or fork that could not get a machine was removed. `GET /sandboxes/{sandboxId}` reports it once, with only `id`, `state` and `error`, then answers 404.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.state","typeLabel":"enum\u003cstring>"},"desktopAvailable":{"type":"boolean","isRequired":true,"uniqueKey":"sandbox.oneOf.0.desktopAvailable","typeLabel":"boolean"},"snapshotAvailable":{"type":"boolean","isRequired":true,"uniqueKey":"sandbox.oneOf.0.snapshotAvailable","typeLabel":"boolean"},"error":{"oneOf":[{"type":"string","description":"Why the sandbox is stopped, failed or cancelled, or null.","uniqueKey":"sandbox.oneOf.0.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the sandbox is stopped, failed or cancelled, or null.","uniqueKey":"sandbox.oneOf.0.error.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.error","typeLabel":"string | null"},"dataExpiredAt":{"oneOf":[{"type":"string","format":"date-time","description":"When Boat deleted the snapshot data of this stopped sandbox, 14 days after it stopped. Resume and fork then fail with `409 snapshot_data_expired`. Null while the data is kept.","uniqueKey":"sandbox.oneOf.0.dataExpiredAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When Boat deleted the snapshot data of this stopped sandbox, 14 days after it stopped. Resume and fork then fail with `409 snapshot_data_expired`. Null while the data is kept.","uniqueKey":"sandbox.oneOf.0.dataExpiredAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.dataExpiredAt","typeLabel":"string\u003cdate-time> | null"},"stoppedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the sandbox last stopped, by any cause: your stop, its auto-stop, a plan limit or Boat. Null while the sandbox is not stopped.","uniqueKey":"sandbox.oneOf.0.stoppedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the sandbox last stopped, by any cause: your stop, its auto-stop, a plan limit or Boat. Null while the sandbox is not stopped.","uniqueKey":"sandbox.oneOf.0.stoppedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.stoppedAt","typeLabel":"string\u003cdate-time> | null"},"labels":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"sandbox.oneOf.0.labels.additionalProperties","typeLabel":"string"},"description":"The labels set at create or fork. Empty when none were set.","uniqueKey":"sandbox.oneOf.0.labels","typeLabel":"object"},"health":{"type":"string","enum":["ok","degraded"],"description":"`degraded` when the machine is alive but Boat cannot fully reach it (for example a firewall rule inside the sandbox blocks the tunnel). The sandbox keeps running.","uniqueKey":"sandbox.oneOf.0.health","typeLabel":"enum\u003cstring>"},"healthReason":{"oneOf":[{"type":"string","description":"Why the sandbox is degraded, or null.","uniqueKey":"sandbox.oneOf.0.healthReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the sandbox is degraded, or null.","uniqueKey":"sandbox.oneOf.0.healthReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.healthReason","typeLabel":"string | null"},"degradedSince":{"oneOf":[{"type":"string","format":"date-time","description":"When the sandbox became degraded, or null.","uniqueKey":"sandbox.oneOf.0.degradedSince.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the sandbox became degraded, or null.","uniqueKey":"sandbox.oneOf.0.degradedSince.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.degradedSince","typeLabel":"string\u003cdate-time> | null"},"hydrated":{"type":"boolean","description":"True once every file of the sandbox's snapshot is on its disk. A resumed or forked sandbox is usable before that: its files keep copying in the background, and its docker volumes move onto the real disk near the end. Its docker containers start earlier; at that point their volume mounts move onto the real disk in place, without a restart. The `sandbox.hydrated` webhook fires at the same moment this turns true. A sandbox that restored nothing is hydrated from the start.","uniqueKey":"sandbox.oneOf.0.hydrated","typeLabel":"boolean"},"hydratedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the last resume or fork finished copying files in, or null.","uniqueKey":"sandbox.oneOf.0.hydratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the last resume or fork finished copying files in, or null.","uniqueKey":"sandbox.oneOf.0.hydratedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.hydratedAt","typeLabel":"string\u003cdate-time> | null"},"hydration":{"oneOf":[{"type":"null","description":"Restore progress while `hydrated` is false, on GET /sandboxes/{id} only. Null in lists, after hydration, or when the sandbox does not answer within 1.5 s.","uniqueKey":"sandbox.oneOf.0.hydration.oneOf.0","typeLabel":"null"},{"type":"object","description":"Restore progress while `hydrated` is false, on GET /sandboxes/{id} only. Null in lists, after hydration, or when the sandbox does not answer within 1.5 s.","required":["phase","entriesDone","entriesTotal","percent"],"properties":{"phase":{"type":"string","description":"Restore step: `dvol` (docker volumes), `sysdelta` (system files), `images` (saved docker images), `hydrating` (the home directory), `reconciling` (the last check). `degraded` and `stuck` mean a step failed and is retried.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.phase","typeLabel":"string"},"entriesDone":{"type":"integer","description":"Files, directories and links copied in so far.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.entriesDone","typeLabel":"integer"},"entriesTotal":{"oneOf":[{"type":"integer","description":"Files, directories and links this restore copies in. Null for the first seconds, until the system files are counted.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.entriesTotal.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Files, directories and links this restore copies in. Null for the first seconds, until the system files are counted.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.entriesTotal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.entriesTotal","typeLabel":"integer | null"},"percent":{"oneOf":[{"type":"integer","description":"entriesDone of entriesTotal, 0-99. Files you change during the restore are yours, not copied, so it can stop short of 99; `hydrated` is the end signal.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.percent.oneOf.0","typeLabel":"integer"},{"type":"null","description":"entriesDone of entriesTotal, 0-99. Files you change during the restore are yours, not copied, so it can stop short of 99; `hydrated` is the end signal.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1.percent","typeLabel":"integer | null"}},"uniqueKey":"sandbox.oneOf.0.hydration.oneOf.1","typeLabel":"object"}],"uniqueKey":"sandbox.oneOf.0.hydration","typeLabel":"null | object"},"type":{"type":"string","enum":["small","default","large","xlarge"],"description":"Current machine size: what the sandbox was created with, or the size it was last resumed or forked onto.","uniqueKey":"sandbox.oneOf.0.type","typeLabel":"enum\u003cstring>"},"vcpu":{"type":"integer","description":"vCPUs guaranteed by this sandbox's type.","examples":[4],"uniqueKey":"sandbox.oneOf.0.vcpu","typeLabel":"integer"},"memoryGB":{"type":"integer","description":"RAM in GB guaranteed by this sandbox's type.","examples":[8],"uniqueKey":"sandbox.oneOf.0.memoryGB","typeLabel":"integer"},"billingMultiplier":{"type":"number","description":"Rate at which this sandbox consumes machine time. 0.5 for `small`, 1 for `default`, 2 for `large`, and 50/9 (about 5.56) for `xlarge`.","examples":[1],"uniqueKey":"sandbox.oneOf.0.billingMultiplier","typeLabel":"number"},"machineProvider":{"oneOf":[{"type":"string","enum":["hetzner","baremetal",null],"description":"Machine provider of the machine the sandbox is on, or null when it has no machine.","uniqueKey":"sandbox.oneOf.0.machineProvider.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["hetzner","baremetal",null],"description":"Machine provider of the machine the sandbox is on, or null when it has no machine.","uniqueKey":"sandbox.oneOf.0.machineProvider.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.machineProvider","typeLabel":"enum\u003cstring> | null"},"url":{"oneOf":[{"type":"string","format":"uri","description":"Machine URL when assigned.","uniqueKey":"sandbox.oneOf.0.url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Machine URL when assigned.","uniqueKey":"sandbox.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.url","typeLabel":"string\u003curi> | null"},"ip":{"oneOf":[{"type":"string","description":"Machine IPv6 or IPv4 address when assigned.","uniqueKey":"sandbox.oneOf.0.ip.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine IPv6 or IPv4 address when assigned.","uniqueKey":"sandbox.oneOf.0.ip.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.ip","typeLabel":"string | null"},"sshEndpoint":{"oneOf":[{"type":"string","description":"Public IPv4 `host:port` that forwards to the sandbox SSH server. Set only when the machine has no public IPv4 of its own; null otherwise. Connect with `ssh -p \u003cport> user@\u003chost>`.","examples":["203.0.113.10:22001"],"uniqueKey":"sandbox.oneOf.0.sshEndpoint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public IPv4 `host:port` that forwards to the sandbox SSH server. Set only when the machine has no public IPv4 of its own; null otherwise. Connect with `ssh -p \u003cport> user@\u003chost>`.","examples":["203.0.113.10:22001"],"uniqueKey":"sandbox.oneOf.0.sshEndpoint.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.sshEndpoint","typeLabel":"string | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"sandbox.oneOf.0.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"sandbox.oneOf.0.createdAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.createdAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"sandbox.oneOf.0.updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"sandbox.oneOf.0.updatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time> | null"},"archiveAfter":{"oneOf":[{"type":"string","format":"date-time","description":"When the sandbox stops by itself (the stop starts within about 5 seconds), or null when auto-stop is disabled. A sandbox whose agent is working gets a fresh full TTL, and this time moves forward.","uniqueKey":"sandbox.oneOf.0.archiveAfter.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the sandbox stops by itself (the stop starts within about 5 seconds), or null when auto-stop is disabled. A sandbox whose agent is working gets a fresh full TTL, and this time moves forward.","uniqueKey":"sandbox.oneOf.0.archiveAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.archiveAfter","typeLabel":"string\u003cdate-time> | null"},"ttlSeconds":{"oneOf":[{"type":"integer","description":"The auto-stop length as last set on create, resume, fork or PATCH, or null when auto-stop is disabled.","uniqueKey":"sandbox.oneOf.0.ttlSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The auto-stop length as last set on create, resume, fork or PATCH, or null when auto-stop is disabled.","uniqueKey":"sandbox.oneOf.0.ttlSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.ttlSeconds","typeLabel":"integer | null"},"desktopUrl":{"oneOf":[{"type":"string","format":"uri","description":"Secret-bearing desktop stream URL when available. Redact from logs.","uniqueKey":"sandbox.oneOf.0.desktopUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Secret-bearing desktop stream URL when available. Redact from logs.","uniqueKey":"sandbox.oneOf.0.desktopUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.desktopUrl","typeLabel":"string\u003curi> | null"},"snapshots":{"type":"boolean","description":"False when the sandbox was created with snapshots off.","uniqueKey":"sandbox.oneOf.0.snapshots","typeLabel":"boolean"},"monitoring":{"type":"boolean","description":"False when the sandbox was created with monitoring off.","uniqueKey":"sandbox.oneOf.0.monitoring","typeLabel":"boolean"},"snapshotCompletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent successfully completed snapshot, or null.","uniqueKey":"sandbox.oneOf.0.snapshotCompletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent successfully completed snapshot, or null.","uniqueKey":"sandbox.oneOf.0.snapshotCompletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.snapshotCompletedAt","typeLabel":"string\u003cdate-time> | null"},"snapshotVerifiedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Last time a snapshot confirmed the sandbox's saved state, including checks that found nothing new to save. Falls back to `snapshotCompletedAt`; null if never.","uniqueKey":"sandbox.oneOf.0.snapshotVerifiedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last time a snapshot confirmed the sandbox's saved state, including checks that found nothing new to save. Falls back to `snapshotCompletedAt`; null if never.","uniqueKey":"sandbox.oneOf.0.snapshotVerifiedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.snapshotVerifiedAt","typeLabel":"string\u003cdate-time> | null"},"team":{"oneOf":[{"type":"object","description":"The organization billed for this sandbox, or null when the owner is billed.","required":["id","name"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"sandbox.oneOf.0.team.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"sandbox.oneOf.0.team.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"sandbox.oneOf.0.team.oneOf.0","typeLabel":"object"},{"type":"null","description":"The organization billed for this sandbox, or null when the owner is billed.","required":["id","name"],"properties":{"id":{"type":"string"},"name":{"type":"string"}},"uniqueKey":"sandbox.oneOf.0.team.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.team","typeLabel":"object | null"},"createdBy":{"oneOf":[{"type":"string","description":"Display name (or email) of the person who created the sandbox. Organization members see every sandbox the organization pays for, so this says whose it is.","uniqueKey":"sandbox.oneOf.0.createdBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Display name (or email) of the person who created the sandbox. Organization members see every sandbox the organization pays for, so this says whose it is.","uniqueKey":"sandbox.oneOf.0.createdBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.createdBy","typeLabel":"string | null"},"createdById":{"oneOf":[{"type":"string","description":"Account id of the person who created the sandbox.","uniqueKey":"sandbox.oneOf.0.createdById.oneOf.0","typeLabel":"string"},{"type":"null","description":"Account id of the person who created the sandbox.","uniqueKey":"sandbox.oneOf.0.createdById.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.createdById","typeLabel":"string | null"},"access":{"type":"string","enum":["owner","use","view"],"description":"What you may do with this sandbox. `owner`: you created it. `use`: a teammate's organization sandbox that is `shared` (see `visibility`), so you can open, run commands in, prompt, resume and stop it. `view`: a teammate's organization sandbox that is `private`, so you can see it and stop it until they share it (`POST /sandboxes/{sandboxId}/share`).","uniqueKey":"sandbox.oneOf.0.access","typeLabel":"enum\u003cstring>"},"holdsCreatorLogins":{"type":"boolean","description":"True while the sandbox still holds its creator's personal logins (GitHub token, model logins, secrets). Other members can only see such a sandbox.","uniqueKey":"sandbox.oneOf.0.holdsCreatorLogins","typeLabel":"boolean"},"visibility":{"oneOf":[{"type":"string","enum":["shared","private",null],"description":"Organization sandboxes only; null for a personal sandbox. `shared`: every member can use it. It holds none of its creator's personal logins (`noEnv`, shared and restarted, or created on an environment that passes nothing) and its creator did not make it private. `private`: only its creator can use it. It holds their logins, or its creator made it private (`POST /sandboxes/{sandboxId}/unshare`, or the organization's `newSandboxesPrivate` default).","uniqueKey":"sandbox.oneOf.0.visibility.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["shared","private",null],"description":"Organization sandboxes only; null for a personal sandbox. `shared`: every member can use it. It holds none of its creator's personal logins (`noEnv`, shared and restarted, or created on an environment that passes nothing) and its creator did not make it private. `private`: only its creator can use it. It holds their logins, or its creator made it private (`POST /sandboxes/{sandboxId}/unshare`, or the organization's `newSandboxesPrivate` default).","uniqueKey":"sandbox.oneOf.0.visibility.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.visibility","typeLabel":"enum\u003cstring> | null"},"cost":{"type":"object","description":"Only with `include=cost` on `GET /sandboxes`. Machine time this sandbox used this calendar month (UTC), at list price. Same meter as `GET /sandboxes/{sandboxId}/usage`.","required":["since","seconds","dollars"],"properties":{"since":{"type":"string","format":"date-time","description":"The 1st of this month, 00:00 UTC.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.cost.since","typeLabel":"string\u003cdate-time>"},"seconds":{"type":"integer","description":"Billable machine-seconds, size multiplier applied.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.cost.seconds","typeLabel":"integer"},"dollars":{"type":"number","description":"seconds / secondsPerDollar, at list price.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.cost.dollars","typeLabel":"number"}},"uniqueKey":"sandbox.oneOf.0.cost","typeLabel":"object"},"wipePendingUntilRestart":{"type":"boolean","description":"True once the sandbox is shared but not restarted yet. Its creator's logins are wiped at its next start, and the organization can use it from then on.","uniqueKey":"sandbox.oneOf.0.wipePendingUntilRestart","typeLabel":"boolean"},"subdomain":{"oneOf":[{"type":"string","description":"The sandbox's stable three-word subdomain slug (e.g. \"frazil-pneuma-rallye\"), or null before one is assigned.","uniqueKey":"sandbox.oneOf.0.subdomain.oneOf.0","typeLabel":"string"},{"type":"null","description":"The sandbox's stable three-word subdomain slug (e.g. \"frazil-pneuma-rallye\"), or null before one is assigned.","uniqueKey":"sandbox.oneOf.0.subdomain.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.subdomain","typeLabel":"string | null"},"lastSnapshotAttemptAt":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the most recent snapshot attempt of any status (queued, in_progress, completed, failed, cancelled), or null. Use with snapshotCompletedAt to detect snapshots that keep failing.","uniqueKey":"sandbox.oneOf.0.lastSnapshotAttemptAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the most recent snapshot attempt of any status (queued, in_progress, completed, failed, cancelled), or null. Use with snapshotCompletedAt to detect snapshots that keep failing.","uniqueKey":"sandbox.oneOf.0.lastSnapshotAttemptAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.lastSnapshotAttemptAt","typeLabel":"string\u003cdate-time> | null"},"lastSnapshotStatus":{"oneOf":[{"type":"string","enum":["queued","in_progress","completed","failed","cancelled",null],"description":"Status of the most recent snapshot attempt, or null if none. A value other than completed while snapshotCompletedAt stays stale indicates failing snapshots.","uniqueKey":"sandbox.oneOf.0.lastSnapshotStatus.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["queued","in_progress","completed","failed","cancelled",null],"description":"Status of the most recent snapshot attempt, or null if none. A value other than completed while snapshotCompletedAt stays stale indicates failing snapshots.","uniqueKey":"sandbox.oneOf.0.lastSnapshotStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.lastSnapshotStatus","typeLabel":"enum\u003cstring> | null"},"lastReboot":{"oneOf":[{"type":"object","description":"The last time the sandbox's kernel restarted on its machine, or null if it never did. Every process running at that time ended. `crash` means the system log ended with no shutdown, for example after a kernel panic.","properties":{"at":{"type":"string","format":"date-time","uniqueKey":"sandbox.oneOf.0.lastReboot.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"reason":{"type":"string","enum":["crash","clean","unknown"],"uniqueKey":"sandbox.oneOf.0.lastReboot.oneOf.0.reason","typeLabel":"enum\u003cstring>"}},"uniqueKey":"sandbox.oneOf.0.lastReboot.oneOf.0","typeLabel":"object"},{"type":"null","description":"The last time the sandbox's kernel restarted on its machine, or null if it never did. Every process running at that time ended. `crash` means the system log ended with no shutdown, for example after a kernel panic.","properties":{"at":{"type":"string","format":"date-time"},"reason":{"type":"string","enum":["crash","clean","unknown"]}},"uniqueKey":"sandbox.oneOf.0.lastReboot.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.lastReboot","typeLabel":"object | null"},"setupStatus":{"oneOf":[{"type":"string","enum":["pending","running","done","failed",null],"description":"Outcome of the create-time `setupScript`: `pending` (stored, not yet started), `running` (executing on the sandbox in the background), `done` (exit code 0) or `failed` (non-zero exit, or the sandbox lost track of the process). Null when the sandbox was created without a setup script.","uniqueKey":"sandbox.oneOf.0.setupStatus.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pending","running","done","failed",null],"description":"Outcome of the create-time `setupScript`: `pending` (stored, not yet started), `running` (executing on the sandbox in the background), `done` (exit code 0) or `failed` (non-zero exit, or the sandbox lost track of the process). Null when the sandbox was created without a setup script.","uniqueKey":"sandbox.oneOf.0.setupStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.setupStatus","typeLabel":"enum\u003cstring> | null"},"setupError":{"oneOf":[{"type":"string","description":"Short failure detail (exit code plus a stderr tail) when `setupStatus` is `failed`; while `pending`, may carry the last start/upload error from a retry in progress. Otherwise null.","uniqueKey":"sandbox.oneOf.0.setupError.oneOf.0","typeLabel":"string"},{"type":"null","description":"Short failure detail (exit code plus a stderr tail) when `setupStatus` is `failed`; while `pending`, may carry the last start/upload error from a retry in progress. Otherwise null.","uniqueKey":"sandbox.oneOf.0.setupError.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.setupError","typeLabel":"string | null"},"environment":{"oneOf":[{"type":"string","description":"Name of the sandbox environment this sandbox is running, or null if it is attached to none (a `noEnv` sandbox, or one whose environment was deleted). A sandbox freezes onto one environment version when it starts and keeps it for life, so this is what the sandbox actually holds, not what the environment says today.","examples":["base"],"uniqueKey":"sandbox.oneOf.0.environment.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the sandbox environment this sandbox is running, or null if it is attached to none (a `noEnv` sandbox, or one whose environment was deleted). A sandbox freezes onto one environment version when it starts and keeps it for life, so this is what the sandbox actually holds, not what the environment says today.","examples":["base"],"uniqueKey":"sandbox.oneOf.0.environment.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.environment","typeLabel":"string | null"},"environmentVersion":{"oneOf":[{"type":"integer","description":"Version number of `environment` that this sandbox is pinned to. Compare it against the environment's latest version to see whether an upgrade is pending: a sandbox below the latest is still running the older configuration until someone calls `POST /environments/{environmentId}/upgrade`.","examples":[3],"uniqueKey":"sandbox.oneOf.0.environmentVersion.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Version number of `environment` that this sandbox is pinned to. Compare it against the environment's latest version to see whether an upgrade is pending: a sandbox below the latest is still running the older configuration until someone calls `POST /environments/{environmentId}/upgrade`.","examples":[3],"uniqueKey":"sandbox.oneOf.0.environmentVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.environmentVersion","typeLabel":"integer | null"},"stop":{"oneOf":[{"type":"object","description":"The last stop you requested (`POST /sandboxes/{sandboxId}/stop`), or null if you never stopped this sandbox.","required":["id","status","requestedAt","lastAttemptAt","error","endedAt"],"properties":{"id":{"type":"string","description":"Stable id of this stop. Calling stop again while it is pending returns the same id.","examples":["stop_3f9a1c2e7b4d5a60"],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.id","typeLabel":"string"},"status":{"type":"string","enum":["pending","failing","completed","superseded"],"description":"`pending`: accepted, the sandbox is archiving. `failing`: the last attempt failed (see `error`); it is retried automatically until the sandbox archives. Running commands or prompts does not cancel it. `completed`: the sandbox is archived. `superseded`: a resume ended it before it completed.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.status","typeLabel":"enum\u003cstring>"},"requestedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the stop was accepted. On the sandbox, null once it has ended. Read by id (`GET /sandboxes/{sandboxId}/stops/{stopId}`), it is kept.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.requestedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the stop was accepted. On the sandbox, null once it has ended. Read by id (`GET /sandboxes/{sandboxId}/stops/{stopId}`), it is kept.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.requestedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.requestedAt","typeLabel":"string\u003cdate-time> | null"},"lastAttemptAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the last archival attempt ended.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.lastAttemptAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the last archival attempt ended.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.lastAttemptAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.lastAttemptAt","typeLabel":"string\u003cdate-time> | null"},"error":{"oneOf":[{"type":"string","description":"Why the last attempt failed, while `status` is `failing`. Otherwise null.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Why the last attempt failed, while `status` is `failing`. Otherwise null.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.error","typeLabel":"string | null"},"endedAt":{"oneOf":[{"type":"string","format":"date-time","description":"When the stop completed or was superseded.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.endedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the stop completed or was superseded.","isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.endedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.endedAt","typeLabel":"string\u003cdate-time> | null"},"forced":{"type":"boolean","description":"True when a force (`--force`) ended this stop. The sandbox kept its last completed snapshot, and changes after it are discarded.","uniqueKey":"sandbox.oneOf.0.stop.oneOf.0.forced","typeLabel":"boolean"}},"uniqueKey":"sandbox.oneOf.0.stop.oneOf.0","typeLabel":"object"},{"type":"null","description":"The last stop you requested (`POST /sandboxes/{sandboxId}/stop`), or null if you never stopped this sandbox.","uniqueKey":"sandbox.oneOf.0.stop.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox.oneOf.0.stop","typeLabel":"object | null"}},"uniqueKey":"sandbox.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"sandbox.oneOf.1","typeLabel":"null"}],"uniqueKey":"sandbox","typeLabel":"object | null"},"giftLimitNotice":{"type":"string","description":"Present on resume or fork when a fair-use cap on a gifted account shortened the requested auto-stop time.","uniqueKey":"giftLimitNotice","typeLabel":"string"},"conversationId":{"type":"string","description":"On interrupt, the conversation whose turn was interrupted.","uniqueKey":"conversationId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"interrupted":{"title":"interrupted","value":{"ok":true,"type":"sandbox.interrupted","id":"bx_23456789","status":"interrupted"}}},"exampleType":"examples"}},"exampleType":"examples"},"145d39ec-f159-49f1-8de6-00f4c78eddd0":{"description":"Missing or invalid bearer token.","content":{"application/json":{"schema":{"type":"object","required":["ok","type","status","code","message","error","requestId"],"properties":{"ok":{"type":"boolean","examples":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"type":{"type":"string","examples":["sandbox.error"],"isRequired":true,"uniqueKey":"type","typeLabel":"string"},"status":{"type":"integer","examples":[409],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","examples":["provider_not_configured"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","examples":["Prompting is locked until Codex is configured on the Agents page."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","examples":["req_01HX..."],"isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unauthorized":{"title":"unauthorized","value":{"ok":false,"type":"sandbox.error","status":401,"code":"unauthorized","message":"Unauthorized","error":{"code":"unauthorized","message":"Unauthorized","status":401},"requestId":"req_01HX..."}}},"exampleType":"examples"}},"exampleType":"examples"},"1bbcc98b-8ed0-47d1-b7b0-6078400df533":{"description":"Account cannot currently create or operate sandboxes. The error body may include a dashboard billing URL, but billing actions are not part of the v1 API.","content":{"application/json":{"schema":{"type":"object","required":["ok","type","status","code","message","error","requestId"],"properties":{"ok":{"type":"boolean","examples":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"type":{"type":"string","examples":["sandbox.error"],"isRequired":true,"uniqueKey":"type","typeLabel":"string"},"status":{"type":"integer","examples":[409],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","examples":["provider_not_configured"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","examples":["Prompting is locked until Codex is configured on the Agents page."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","examples":["req_01HX..."],"isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"type":"sandbox.error","status":409,"code":"provider_not_configured","message":"Prompting is locked until Codex is configured on the Agents page.","requestId":"req_01HX...","error":{"code":"\u003cstring>","message":"\u003cstring>","status":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"7f823c9b-d045-440d-952b-23641b19cd3f":{"description":"Resource not found.","content":{"application/json":{"schema":{"type":"object","required":["ok","type","status","code","message","error","requestId"],"properties":{"ok":{"type":"boolean","examples":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"type":{"type":"string","examples":["sandbox.error"],"isRequired":true,"uniqueKey":"type","typeLabel":"string"},"status":{"type":"integer","examples":[409],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","examples":["provider_not_configured"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","examples":["Prompting is locked until Codex is configured on the Agents page."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","examples":["req_01HX..."],"isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"type":"sandbox.error","status":409,"code":"provider_not_configured","message":"Prompting is locked until Codex is configured on the Agents page.","requestId":"req_01HX...","error":{"code":"\u003cstring>","message":"\u003cstring>","status":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"411daa6d-3fc4-4f7f-a54f-eb51c9cfe8af":{"description":"Request conflicts with current account or sandbox state.","content":{"application/json":{"schema":{"type":"object","required":["ok","type","status","code","message","error","requestId"],"properties":{"ok":{"type":"boolean","examples":[false],"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"type":{"type":"string","examples":["sandbox.error"],"isRequired":true,"uniqueKey":"type","typeLabel":"string"},"status":{"type":"integer","examples":[409],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","examples":["provider_not_configured"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","examples":["Prompting is locked until Codex is configured on the Agents page."],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","examples":["req_01HX..."],"isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"error":{"type":"object","required":["code","message","status"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"details":{"type":"object","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":false,"type":"sandbox.error","status":409,"code":"provider_not_configured","message":"Prompting is locked until Codex is configured on the Agents page.","requestId":"req_01HX...","error":{"code":"\u003cstring>","message":"\u003cstring>","status":123,"details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3164fa28-cf6f-4842-8803-d0c669b5bec3":{"BoatBearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"sandbox_api_key","description":"Boat bearer token in the form `boat_...`. Service API keys authenticate sandbox operations.","scopes":[],"schemeName":"BoatBearerAuth"}}},"servers":{"eb19bdfe-1d1c-4f2b-9f80-620e450766ba":{"url":"https://boat.dev/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"sandbox_api_key","description":"Boat bearer token in the form `boat_...`. Service API keys authenticate sandbox operations.","scopes":[],"schemeName":"BoatBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Boat bearer token in the form `boat_...`. Service API keys authenticate sandbox operations.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BoatBearerAuth","name":"Authorization"}],"title":"BoatBearerAuth"}]},"originalFileLocation":"openapi/boat-v1.yaml"},"subdomain":"ariana-1e97e6c3","siteName":"boat","title":"Interrupt running work - boat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T16:43:16.758Z","originalFileLocation":"api/reference/agent/interrupt-running-agent-work.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"boat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Interrupt running work - boat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"boat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ariana-1e97e6c3.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Interrupt+running+work\u0026amp;description=Interrupt+running+agent+work.+By+default+this+stops+**every**+conversation+on+the+sandbox.+Pass+%60conversation%60+to+stop+just+one%2C+leaving+the+others+running.+See\u0026amp;theme=7f740fc21976e49484852a50\u0026amp;signature=c225ada102567f9cae97682ce6a7be77179166b0b058f0d60cc7fc39282538ac\">\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=\"Interrupt running work - boat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ariana-1e97e6c3.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Interrupt+running+work\u0026amp;description=Interrupt+running+agent+work.+By+default+this+stops+**every**+conversation+on+the+sandbox.+Pass+%60conversation%60+to+stop+just+one%2C+leaving+the+others+running.+See\u0026amp;theme=7f740fc21976e49484852a50\u0026amp;signature=c225ada102567f9cae97682ce6a7be77179166b0b058f0d60cc7fc39282538ac\">\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/ariana-1e97e6c3/-GnxSLDa4mVTPFCa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"boat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#263FA9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/reference/agent/interrupt-running-agent-work.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.boat.dev/#organization\",\"name\":\"boat\",\"url\":\"https://docs.boat.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ariana-1e97e6c3/qYEPg6P4ACx7GhnX/logo/light.svg?fit=max\u0026auto=format\u0026n=qYEPg6P4ACx7GhnX\u0026q=85\u0026s=eaa1695372bf1bda281c905925c68573\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.boat.dev#website\",\"name\":\"boat\",\"url\":\"https://docs.boat.dev\",\"publisher\":{\"@id\":\"https://docs.boat.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work#webpage\",\"url\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work\",\"name\":\"Interrupt running work\",\"description\":\"Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.\",\"dateModified\":\"2026-09-16T16:43:16.758Z\",\"isPartOf\":{\"@id\":\"https://docs.boat.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.boat.dev/api/reference/agent/prompt-sandbox-agent\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Interrupt running work\",\"item\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work#apireference\",\"headline\":\"Interrupt running work\",\"name\":\"Interrupt running work\",\"description\":\"Interrupt running agent work. By default this stops every conversation on the sandbox. Pass conversation to stop just one, leaving the others running. See Integrated agents.\",\"url\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work\",\"mainEntityOfPage\":{\"@id\":\"https://docs.boat.dev/api/reference/agent/interrupt-running-agent-work#webpage\"},\"dateModified\":\"2026-09-16T16:43:16.758Z\",\"publisher\":{\"@id\":\"https://docs.boat.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.boat.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"boat\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"boat","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/quickstart"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/billing"}]},{"tab":"Reference","groups":[{"group":"Tools","pages":[{"title":"CLI reference","href":"/cli-reference"},{"title":"SDKs","href":"/sdks/overview"},{"title":"Python SDK","href":"/sdks/python"},{"title":"TypeScript SDK","href":"/sdks/typescript"}]},{"group":"API","pages":[{"title":"API overview","href":"/api/v1"}]},{"group":"Sandboxes","pages":[{"title":"List sandboxes","openapi":"openapi/boat-v1.yaml GET /sandboxes","href":"/api/reference/sandboxes/list-sandboxes"},{"title":"Create sandbox","openapi":"openapi/boat-v1.yaml POST /sandboxes","href":"/api/reference/sandboxes/create-sandbox"},{"title":"Get sandbox","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}","href":"/api/reference/sandboxes/get-sandbox"},{"title":"Update sandbox","openapi":"openapi/boat-v1.yaml PATCH /sandboxes/{sandboxId}","href":"/api/reference/sandboxes/update-sandbox"},{"title":"Stop sandbox","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/stop","href":"/api/reference/sandboxes/stop-and-archive-sandbox"},{"title":"Get a stop","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/stops/{stopId}","href":"/api/reference/sandboxes/get-stop"},{"title":"Resume sandbox","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/resume","href":"/api/reference/sandboxes/resume-sandbox"},{"title":"Fork sandbox","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/fork","href":"/api/reference/sandboxes/fork-sandbox"},{"title":"Recover sandbox","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/recover","href":"/api/reference/sandboxes/recover-sandbox"},{"title":"Share sandbox with the organization","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/share","href":"/api/reference/sandboxes/share-sandbox"},{"title":"Make an organization sandbox private","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/unshare","href":"/api/reference/sandboxes/unshare-sandbox"},{"title":"Get sandbox usage","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/usage","href":"/api/reference/sandboxes/get-sandbox-usage"},{"title":"Delete sandbox","openapi":"openapi/boat-v1.yaml DELETE /sandboxes/{sandboxId}","href":"/api/reference/sandboxes/permanently-delete-sandbox-data"}]},{"group":"Commands","pages":[{"title":"Run a command","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/commands","href":"/api/reference/agent/execute-sandbox-command"},{"title":"Get command status","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/commands/{processId}","href":"/api/reference/agent/get-command-status"},{"title":"Attach to a detached command","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/commands/{processId}/stream","href":"/api/reference/agent/attach-command"},{"title":"Stop a detached command","openapi":"openapi/boat-v1.yaml DELETE /sandboxes/{sandboxId}/commands/{processId}","href":"/api/reference/agent/stop-command"},{"title":"List the command history","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/command-history","href":"/api/reference/agent/list-command-history"},{"title":"Get a command from the history","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/command-history/{commandId}","href":"/api/reference/agent/get-command"},{"title":"Read command logs","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/command-history/{commandId}/logs","href":"/api/reference/agent/read-command-logs"},{"title":"List sandbox processes","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/processes","href":"/api/reference/agent/list-sandbox-processes"}]},{"group":"Files","pages":[{"title":"Read a file","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files","href":"/api/reference/agent/read-sandbox-file"},{"title":"Write a file","openapi":"openapi/boat-v1.yaml PUT /sandboxes/{sandboxId}/files","href":"/api/reference/agent/write-sandbox-file"},{"title":"List a directory","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files/list","href":"/api/reference/agent/list-sandbox-files"},{"title":"Get file details","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files/info","href":"/api/reference/agent/get-sandbox-file-info"},{"title":"Search files by name","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files/search","href":"/api/reference/agent/search-sandbox-files"},{"title":"Find text in files","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files/find","href":"/api/reference/agent/find-in-sandbox-files"},{"title":"Create a directory","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/folder","href":"/api/reference/agent/create-sandbox-folder"},{"title":"Move or rename a file","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/move","href":"/api/reference/agent/move-sandbox-file"},{"title":"Set file permissions","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/permissions","href":"/api/reference/agent/set-sandbox-file-permissions"},{"title":"Replace text in files","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/replace","href":"/api/reference/agent/replace-in-sandbox-files"},{"title":"Delete a file","openapi":"openapi/boat-v1.yaml DELETE /sandboxes/{sandboxId}/files","href":"/api/reference/agent/delete-sandbox-file"},{"title":"Get a download URL for a sandbox file","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/download-url","href":"/api/reference/agent/create-download-url"},{"title":"Get an upload URL for a sandbox file","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/files/upload-url","href":"/api/reference/agent/create-upload-url"},{"title":"Download a file","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/artifacts","href":"/api/reference/agent/download-sandbox-artifact"}]},{"group":"Agents","pages":[{"title":"Prompt the agent","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/prompt","href":"/api/reference/agent/prompt-sandbox-agent"},{"title":"Get prompt run status","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/prompts/{promptId}","href":"/api/reference/agent/get-prompt-run-status"},{"title":"List sandbox events","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/events","href":"/api/reference/agent/list-sandbox-events"},{"title":"List conversations","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/conversations","href":"/api/reference/agent/list-sandbox-conversations"},{"title":"Steer a running turn (API)","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/steer","description":"Send a new message to a turn that is already running, without losing what the agent is doing. This is what typing into a coding agent while it works does: the instruction is taken into account and the work continues.\n\nWhere the harness has a native mid-turn primitive (Claude Code, Codex, pi, Prime Agent) nothing is interrupted and the response has `native: true`. Where it does not (OpenCode), Boat interrupts that turn and immediately continues the SAME conversation with the instruction, keeping the session and its memory, and the response has `native: false`.\n\nRefused with **409 `no_running_turn`** when the conversation has nothing in flight; queue work with `POST /prompt` instead. `error.details.reason` says why: `turn_ended` (with `error.details.lastTurn.status` and `.error` of the newest turn), `turn_not_started` (the turn is starting; retry in a moment), `no_turn`, `not_running` (the sandbox is not running) or `delivery_failed` (the sandbox did not accept the steer; check the turn before sending more work). The steer shows up in `GET /events` as a `steer` event. See [Integrated agents](/integrated-agents).","href":"/api/reference/agent/steer-a-running-turn"},{"title":"Interrupt running work","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/interrupt","href":"/api/reference/agent/interrupt-running-agent-work"}]},{"group":"Access","pages":[{"title":"Expose a port on a public URL","description":"Give a port inside a sandbox a stable HTTPS URL on on.boat.dev, private with a token or public. Same as boat host.","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/host","href":"/api/reference/agent/expose-a-port"},{"title":"Add an SSH key","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/sshkey","href":"/api/reference/agent/configure-sandbox-ssh-key"},{"title":"Get the desktop URL","openapi":"openapi/boat-v1.yaml POST /sandboxes/{sandboxId}/desktop","href":"/api/reference/agent/get-desktop-streaming-url"}]},{"group":"Snapshots","pages":[{"title":"List snapshots","openapi":"openapi/boat-v1.yaml GET /snapshots","href":"/api/reference/snapshots/list-snapshots"},{"title":"List snapshots of a sandbox","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/snapshots","href":"/api/reference/snapshots/list-sandbox-snapshots"},{"title":"Get the latest snapshot of a sandbox","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/snapshots/latest","href":"/api/reference/snapshots/get-latest-sandbox-snapshot"},{"title":"Get snapshot file tree","openapi":"openapi/boat-v1.yaml GET /snapshots/{snapshotId}/tree","href":"/api/reference/snapshots/get-snapshot-tree"},{"title":"Download a file or folder from a snapshot","openapi":"openapi/boat-v1.yaml GET /snapshots/{snapshotId}/files","href":"/api/reference/snapshots/get-snapshot-file"},{"title":"Get snapshot download","openapi":"openapi/boat-v1.yaml GET /snapshots/{snapshotId}/download","href":"/api/reference/snapshots/get-snapshot-download"},{"title":"Delete snapshot","openapi":"openapi/boat-v1.yaml DELETE /snapshots/{snapshotId}","href":"/api/reference/snapshots/permanently-delete-snapshot-data"},{"title":"Delete all snapshots of a sandbox","openapi":"openapi/boat-v1.yaml DELETE /sandboxes/{sandboxId}/snapshots","href":"/api/reference/snapshots/delete-sandbox-snapshots"}]},{"group":"Saved snapshots","pages":[{"title":"List saved snapshots","openapi":"openapi/boat-v1.yaml GET /saved-snapshots","href":"/api/reference/snapshots/list-saved-snapshots"},{"title":"Save a saved snapshot","openapi":"openapi/boat-v1.yaml POST /saved-snapshots","href":"/api/reference/snapshots/save-saved-snapshot"},{"title":"Get a saved snapshot","openapi":"openapi/boat-v1.yaml GET /saved-snapshots/{name}","href":"/api/reference/snapshots/get-saved-snapshot"},{"title":"Delete a saved snapshot","openapi":"openapi/boat-v1.yaml DELETE /saved-snapshots/{name}","href":"/api/reference/snapshots/delete-saved-snapshot"},{"title":"Share a saved snapshot","openapi":"openapi/boat-v1.yaml POST /saved-snapshots/{name}/shares","href":"/api/reference/snapshots/create-snapshot-share"},{"title":"List share codes of a saved snapshot","openapi":"openapi/boat-v1.yaml GET /saved-snapshots/{name}/shares","href":"/api/reference/snapshots/list-snapshot-shares"},{"title":"Revoke a share code","openapi":"openapi/boat-v1.yaml DELETE /saved-snapshots/{name}/shares/{shareId}","href":"/api/reference/snapshots/revoke-snapshot-share"}]},{"group":"Environments","pages":[{"title":"List environments","openapi":"openapi/boat-v1.yaml GET /environments","href":"/api/reference/environments/list-sandbox-environments"},{"title":"Create an environment","openapi":"openapi/boat-v1.yaml POST /environments","href":"/api/reference/environments/create-sandbox-environment"},{"title":"Update an environment","openapi":"openapi/boat-v1.yaml PUT /environments/{environmentId}","href":"/api/reference/environments/update-sandbox-environment"},{"title":"Delete an environment","openapi":"openapi/boat-v1.yaml DELETE /environments/{environmentId}","href":"/api/reference/environments/delete-sandbox-environment"},{"title":"Upgrade sandboxes to the latest environment version","openapi":"openapi/boat-v1.yaml POST /environments/{environmentId}/upgrade","href":"/api/reference/environments/upgrade-sandbox-environment"},{"title":"Set environment variable","openapi":"openapi/boat-v1.yaml PUT /environments/{environmentId}/vars/{key}","href":"/api/reference/environments/set-environment-var"},{"title":"Remove environment variable","openapi":"openapi/boat-v1.yaml DELETE /environments/{environmentId}/vars/{key}","href":"/api/reference/environments/delete-environment-var"},{"title":"Write environment secret file","openapi":"openapi/boat-v1.yaml PUT /environments/{environmentId}/secret-files","href":"/api/reference/environments/set-environment-secret-file"},{"title":"Remove environment secret file","openapi":"openapi/boat-v1.yaml DELETE /environments/{environmentId}/secret-files","href":"/api/reference/environments/delete-environment-secret-file"},{"title":"Add environment repository","openapi":"openapi/boat-v1.yaml POST /environments/{environmentId}/repos","href":"/api/reference/environments/add-environment-repo"},{"title":"Remove environment repository","openapi":"openapi/boat-v1.yaml DELETE /environments/{environmentId}/repos/{repositoryId}","href":"/api/reference/environments/delete-environment-repo"},{"title":"List GitHub repositories","openapi":"openapi/boat-v1.yaml GET /repos","href":"/api/reference/account/list-github-repositories-available-to-sandbox"},{"title":"Select a repository","openapi":"openapi/boat-v1.yaml POST /repos","href":"/api/reference/account/select-repository-for-sandboxes"},{"title":"Get account secrets (legacy)","openapi":"openapi/boat-v1.yaml GET /secrets","href":"/api/reference/account/get-boat-secrets-setup"},{"title":"Update account secrets (legacy)","openapi":"openapi/boat-v1.yaml POST /secrets","href":"/api/reference/account/update-boat-secrets-setup"}]},{"group":"AI credentials","pages":[{"title":"List credential profiles","openapi":"openapi/boat-v1.yaml GET /credential-profiles","href":"/api/reference/ai-credentials/list-credential-profiles"},{"title":"Create a credential profile","openapi":"openapi/boat-v1.yaml POST /credential-profiles","href":"/api/reference/ai-credentials/create-credential-profile"},{"title":"Update a credential profile","openapi":"openapi/boat-v1.yaml PUT /credential-profiles/{profile}","href":"/api/reference/ai-credentials/update-credential-profile"},{"title":"Delete a credential profile","openapi":"openapi/boat-v1.yaml DELETE /credential-profiles/{profile}","href":"/api/reference/ai-credentials/delete-credential-profile"},{"title":"Set a credential profile API key","openapi":"openapi/boat-v1.yaml PUT /credential-profiles/{profile}/keys/{credential}","href":"/api/reference/ai-credentials/set-credential-profile-api-key"},{"title":"Remove a credential profile credential","openapi":"openapi/boat-v1.yaml DELETE /credential-profiles/{profile}/keys/{credential}","href":"/api/reference/ai-credentials/remove-credential-profile-credential"},{"title":"List the accounts of a credential","openapi":"openapi/boat-v1.yaml GET /credential-profiles/{profile}/accounts/{credential}","href":"/api/reference/ai-credentials/list-credential-accounts"},{"title":"Switch a credential to another account","openapi":"openapi/boat-v1.yaml PUT /credential-profiles/{profile}/accounts/{credential}/{account}/active","href":"/api/reference/ai-credentials/switch-credential-account"},{"title":"Add another API key to a credential","openapi":"openapi/boat-v1.yaml POST /credential-profiles/{profile}/accounts/{credential}","href":"/api/reference/ai-credentials/add-credential-account"},{"title":"Forget an account of a credential","openapi":"openapi/boat-v1.yaml DELETE /credential-profiles/{profile}/accounts/{credential}/{account}","href":"/api/reference/ai-credentials/forget-credential-account"},{"title":"Set a custom API","openapi":"openapi/boat-v1.yaml PUT /credential-profiles/{profile}/custom-apis/{name}","href":"/api/reference/ai-credentials/set-custom-api"},{"title":"Remove a custom API","openapi":"openapi/boat-v1.yaml DELETE /credential-profiles/{profile}/custom-apis/{name}","href":"/api/reference/ai-credentials/remove-custom-api"},{"title":"Get AI credentials proxy","openapi":"openapi/boat-v1.yaml GET /ai-proxy","href":"/api/reference/ai-credentials/get-ai-credentials-proxy"},{"title":"Turn the AI credentials proxy on or off","openapi":"openapi/boat-v1.yaml PUT /ai-proxy","href":"/api/reference/ai-credentials/turn-the-ai-credentials-proxy-on-or-off"},{"title":"Get AI usage","openapi":"openapi/boat-v1.yaml GET /ai-usage","href":"/api/reference/ai-credentials/get-ai-usage"},{"title":"Get sandbox AI usage","openapi":"openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/ai-usage","href":"/api/reference/ai-credentials/get-sandbox-ai-usage"},{"title":"Block or unblock sandbox AI access","openapi":"openapi/boat-v1.yaml PUT /sandboxes/{sandboxId}/ai-access","href":"/api/reference/ai-credentials/block-or-unblock-sandbox-ai-access"}]},{"group":"Account and organizations","pages":[{"title":"Get current user","openapi":"openapi/boat-v1.yaml GET /me","href":"/api/reference/account/get-current-boat-user"},{"title":"List organizations","openapi":"openapi/boat-v1.yaml GET /orgs","href":"/api/reference/account/list-organizations"},{"title":"Set the active organization","openapi":"openapi/boat-v1.yaml PATCH /orgs/active","href":"/api/reference/account/set-active-organization"},{"title":"Update organization settings","openapi":"openapi/boat-v1.yaml PATCH /orgs/{org}","href":"/api/reference/account/update-organization"},{"title":"Get account limits","openapi":"openapi/boat-v1.yaml GET /limits","href":"/api/reference/account/get-boat-limits"}]},{"group":"API keys","pages":[{"title":"List API keys","openapi":"openapi/boat-v1.yaml GET /api-keys","href":"/api/reference/account/list-api-keys"},{"title":"Create a scoped API key","openapi":"openapi/boat-v1.yaml POST /api-keys/scoped","href":"/api/reference/account/create-scoped-api-key"},{"title":"Rotate an API key","openapi":"openapi/boat-v1.yaml POST /api-keys/{apiKeyId}/rotate","href":"/api/reference/account/rotate-api-key"},{"title":"Revoke an API key","openapi":"openapi/boat-v1.yaml DELETE /api-keys/{apiKeyId}","href":"/api/reference/account/revoke-api-key"},{"title":"Get API key usage","openapi":"openapi/boat-v1.yaml GET /api-keys/{apiKeyId}/usage","href":"/api/reference/account/get-api-key-usage"}]},{"group":"Webhooks and OpenTelemetry","pages":[{"title":"List webhooks","openapi":"openapi/boat-v1.yaml GET /webhooks","href":"/api/reference/account/list-webhooks"},{"title":"Create webhook","openapi":"openapi/boat-v1.yaml POST /webhooks","href":"/api/reference/account/create-webhook"},{"title":"Get webhook","openapi":"openapi/boat-v1.yaml GET /webhooks/{webhookId}","href":"/api/reference/account/get-webhook"},{"title":"Update webhook","openapi":"openapi/boat-v1.yaml PATCH /webhooks/{webhookId}","href":"/api/reference/account/update-webhook"},{"title":"Delete webhook","openapi":"openapi/boat-v1.yaml DELETE /webhooks/{webhookId}","href":"/api/reference/account/delete-webhook"},{"title":"Rotate webhook signing secret","openapi":"openapi/boat-v1.yaml POST /webhooks/{webhookId}/rotate","href":"/api/reference/account/rotate-webhook-signing-secret"},{"title":"Get OpenTelemetry export","openapi":"openapi/boat-v1.yaml GET /telemetry","href":"/api/reference/account/get-opentelemetry-export"},{"title":"Set OpenTelemetry export","openapi":"openapi/boat-v1.yaml PUT /telemetry","href":"/api/reference/account/set-opentelemetry-export"},{"title":"Remove OpenTelemetry export","openapi":"openapi/boat-v1.yaml DELETE /telemetry","href":"/api/reference/account/remove-opentelemetry-export"}]},{"group":"CI on Boat VMs","pages":[{"title":"Get CI overview","openapi":"openapi/boat-v1.yaml GET /ci","href":"/api/reference/ci/get-ci-overview"},{"title":"Connect GitHub for CI","openapi":"openapi/boat-v1.yaml POST /ci/connect","href":"/api/reference/ci/connect-ci-github"},{"title":"Set CI public repositories","openapi":"openapi/boat-v1.yaml POST /ci/public","href":"/api/reference/ci/set-ci-public-repos"},{"title":"Get CI job","openapi":"openapi/boat-v1.yaml GET /ci/jobs/{jobId}","href":"/api/reference/ci/get-ci-job"},{"title":"Get CI job log","openapi":"openapi/boat-v1.yaml GET /ci/jobs/{jobId}/logs","href":"/api/reference/ci/get-ci-job-log"}]},{"group":"Data retention","pages":[{"title":"Get account data-retention policy","openapi":"openapi/boat-v1.yaml GET /account/data-retention","href":"/api/reference/account/get-account-data-retention-policy"},{"title":"Update account data-retention policy","openapi":"openapi/boat-v1.yaml PATCH /account/data-retention","href":"/api/reference/account/update-account-data-retention-policy"},{"title":"Get deletion operation","openapi":"openapi/boat-v1.yaml GET /deletion-operations/{operationId}","href":"/api/reference/account/get-deletion-operation"}]}]}]},"basePath":"","title":"Interrupt running work - boat","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-m07pfKpT.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}