Freeze a sandbox’s current state under a name (boat snapshot <id> <name> in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot’s artifact once the new save is ready.
{
"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": {}
}
}
Authorizations
Authorization
string
header
required
Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.
Body
application/json
sandboxId
string
required
The sandbox whose current state to freeze.
name
string
required
Name to save under. 1-63 lowercase letters, digits, or dashes, starting with a letter or digit. Reusing one of your existing names replaces that snapshot's artifact. latest, tree, pull, rm, save, current, self, and new are reserved.
Pattern: ^[a-z0-9][a-z0-9-]{0,62}$
Response
Save accepted and running in the background.
ok
boolean
required
Example:
true
type
string
required
Stable success envelope discriminator added by v1.
Allowed value: "snapshot.saved.saving"
status
string
required
Allowed value: "saving"
snapshot
object
required
A saved snapshot: a frozen copy of a sandbox's disk at one moment, saved under a name you pick. Independent of the source sandbox's later life: the sandbox can change, stop, or be deleted and the saved snapshot still deploys. Saved snapshots never expire; re-saving a name replaces its artifact.
{
"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"}},"seo":{"organization":{"id":"https://boat.dev/#organization","name":"boat","legalName":"Dedale AI, Corp.","url":"https://boat.dev","logo":"https://boat.dev/apple-touch-icon.png","sameAs":["https://x.com/boatdotdev","https://www.linkedin.com/company/boatdotdev","https://github.com/ariana-dot-dev","https://discord.com/invite/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":""},"entitlements":{},"buildId":"6afdbdaed6b6c3e01f105af5","clientVersion":"0.0.4177","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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","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/v23/-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/v23/-F63fjptAgt5VM-kVkqdyU8n1isq129k.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\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/v23/-F63fjptAgt5VM-kVkqdyU8n1pUL8lJdhg.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\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/v23/-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/v23/-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/v23/-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/v23/-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/v23/-F6qfjptAgt5VM-kVkqdyU8n3twJwlRFgtIU.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\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/v23/-F6qfjptAgt5VM-kVkqdyU8n3twJwupkp-8tFQ.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\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/v23/-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/v23/-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/v23/-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}*,*::before,*::after{box-shadow:none!important;text-shadow:none!important;backdrop-filter:none!important;-webkit-backdrop-filter:none!important;border-radius:0!important}img.rounded-full,.rounded-full:is([class*=\"size-1\"],[class*=\"size-2\"],[class*=\"w-1\"],[class*=\"w-2\"]){border-radius:9999px!important}html,body{font-family:var(--font-text);letter-spacing:0}body{background-color:var(--wash);color:var(--text)}html.dark body{background-color:var(--deep)}.mdx-content,.mdx-content :is(p,li,blockquote,td),.callout :is(p,li),.card :is(p,span),[data-as=\"p\"]{font-size:16px;line-height:140%}#sidebar,#sidebar *,#table-of-contents,#table-of-contents *,.nav-tabs,.nav-tabs *,#pagination,#pagination *,#footer,#footer *,#navbar a,#navbar button{font-family:var(--font-text);letter-spacing:0}code,kbd,pre,samp,pre *,code *,.font-mono,.method-pill,.method-nav-pill>span{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}strong,b,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:-0.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:-0.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}.card [data-as=\"p\"],.callout [data-as=\"p\"]:last-child{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}.mdx-content table th{color:var(--text)!important}[data-component-part=\"code-group-tab-bar\"] *,#search-bar-entry *,.method-nav-pill>span,.method-pill,.field *,.api-section *,[role=\"menu\"] *,[class*=\"text-xs\"],[class*=\"text-[0.\"]{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 [data-component-part],#pagination a:hover *{color:var(--text)!important}#pagination nav,nav[class*=\"bg-gray-50\"]{background-color:transparent!important}strong,b{color:inherit!important}.code-block-background,[data-component-part=\"code-block-root\"],.code-block-background *{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}.mdx-content :is(p,li,td,blockquote),#content>p,[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\")}}.theme-preference-switch-option svg,#search-bar-entry svg,[data-floating-buttons] button svg,[data-component-part=\"code-group-tab-bar\"] button[aria-label*=\"opy\"i] svg,#page-context-menu-button svg,#sidebar a[href*=\"dashboard\"] 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(.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\")}[data-floating-buttons] button svg,[data-component-part=\"code-group-tab-bar\"] button[aria-label*=\"opy\"i] svg,#page-context-menu-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}:is(#footer a[href*=\"github.com\"],#footer a[href*=\"discord\"]) svg *{visibility:hidden}#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}[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}#navbar-transition,#navbar [class*=\"border-b\"]{border-color:var(--line)!important}#topbar-cta-button a{background-color:var(--ocean)!important;color:var(--wash)!important;border:0!important}#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}li>a[aria-current=\"page\"],#sidebar [data-active]>a,#sidebar a[data-active]{background-color:var(--select)!important;color:var(--select-text)!important;font-weight:500!important}li>a[aria-current=\"page\"] *,#sidebar a[data-active] *{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{color:var(--quiet)!important}#table-of-contents [data-active] a,#table-of-contents a[data-active]{color:var(--accent)!important}.nav-tabs-item{color:var(--quiet)!important}.nav-tabs-item[data-active],.nav-tabs-item[aria-current=\"page\"]{color:var(--text)!important}.nav-tabs-item[data-active]>div:last-child,.nav-tabs-item [class*=\"bg-primary\"]{background-color:var(--accent)!important}.code-block,.code-group{border:1px solid var(--line)!important;background-color:var(--raised)!important}.code-block pre,.code-group pre,pre.shiki{background-color:var(--raised)!important}.code-group>div:not([data-component-part=\"code-group-tab-bar\"]),.code-block>div:not([data-floating-buttons]),.code-block-background,.code-group>div:not([data-component-part=\"code-group-tab-bar\"]) div,.code-block>div 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}[data-component-part=\"code-group-tab-bar\"] button[data-active]{color:var(--text)!important}[data-fade-overlay],.code-block [class*=\"bg-gradient\"],.code-group [class*=\"bg-gradient\"]{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}[data-component-part=\"code-group-tab-bar\"] button{height:48px!important;padding:0!important;margin:0 24px 0 0!important}[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}}pre.shiki,: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]){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 pre.shiki,html.dark :is(pre,code,.font-mono) span[style]{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}.code-group{padding:0!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)}.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 p,.card [data-component-part=\"card-content\"],.card [data-component-part=\"card-content\"] *{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}.field [class*=\"red\"],.api-section [class*=\"text-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)}.accordion,.accordion-group{border-color:var(--line)!important}.accordion summary:hover{background-color:var(--raised)!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}.steps [class*=\"w-px\"],.step [class*=\"w-px\"],.steps [class*=\"border-l\"]{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}#pagination a{border-color:var(--line)!important}#pagination a:hover{border-color:var(--accent)!important}#footer{border-color:var(--line)!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}#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{background-color:var(--ocean)!important;color:var(--wash)!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{background-color:var(--deep)!important}.fixed.inset-0:is([class*=\"bg-black\"],[class*=\"bg-gray\"]){background-color:rgb(6 6 6 / 0.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}html.dark [class*=\"group-hover/mermaid\"].grid button{background-color:var(--deep)!important}.mermaid .actor,.mermaid .labelBox,.mermaid .note,.mermaid rect.activation0,.mermaid rect.activation1,.mermaid rect.activation2,.mermaid .node rect,.mermaid .node polygon,.mermaid .node circle,.mermaid .node path:not(.flowchart-link){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 .messageLine0,.mermaid .messageLine1,.mermaid .loopLine,.mermaid .flowchart-link,.mermaid .edgePath path,.mermaid .transition{stroke:var(--deep)!important}.mermaid .arrowheadPath,.mermaid marker path{fill:var(--deep)!important;stroke:var(--deep)!important}.mermaid text,.mermaid .nodeLabel,.mermaid .edgeLabel,.mermaid span{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){*,*::before,*::after{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/snapshots/save-saved-snapshot","slug":"/api/reference/snapshots/save-saved-snapshot","pageMetadata":{"title":"Save a saved snapshot","openapi":"openapi/boat-v1.yaml POST /saved-snapshots","description":"Freeze a sandbox's current state under a name (`boat snapshot \u003cid> \u003cname>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot's artifact once the new save is ready.","href":"/api/reference/snapshots/save-saved-snapshot"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Freeze a sandbox’s current state under a name (\", _jsx(_components.code, {\n children: \"boat snapshot \u003cid> \u003cname>\"\n }), \" in the CLI). Answers \", _jsx(_components.code, {\n children: \"202\"\n }), \" immediately with the snapshot in \", _jsx(_components.code, {\n children: \"saving\"\n }), \"; a running sandbox takes a fresh capture first, which can run minutes. Poll \", _jsx(_components.code, {\n children: \"GET /saved-snapshots/{name}\"\n }), \" until the status settles at \", _jsx(_components.code, {\n children: \"ready\"\n }), \" or \", _jsx(_components.code, {\n children: \"failed\"\n }), \". Reusing one of your existing names replaces that snapshot’s artifact once the new save is ready.\"]\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":"Save a saved snapshot","openapi":"openapi/boat-v1.yaml POST /saved-snapshots","description":"Freeze a sandbox's current state under a name (`boat snapshot \u003cid> \u003cname>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot's artifact once the new save is ready.","href":"/api/reference/snapshots/save-saved-snapshot"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ariana-1e97e6c3/a7a23abe3f9d2f7b/old-section-links.js"],"openApiReferenceData":{"operation":{"tags":["Boat"],"summary":"Save a saved snapshot","description":"Freeze a sandbox's current state under a name (`boat snapshot \u003cid> \u003cname>` in the CLI). Answers `202` immediately with the snapshot in `saving`; a running sandbox takes a fresh capture first, which can run minutes. Poll `GET /saved-snapshots/{name}` until the status settles at `ready` or `failed`. Reusing one of your existing names replaces that snapshot's artifact once the new save is ready.","operationId":"saveSavedSnapshot","requestBody":"1595f014-6962-47a4-8ccd-fd25aae68683","responses":{"202":"14723766-0ac5-4d66-8223-e65fd22a5c15","400":"3647a19e-b1c5-4cd7-92ab-13a3cdb93f29","401":"773fbad1-506a-4fbb-a829-e211e9084a06","402":"cff168aa-f329-4afe-adb6-af8ab73fef0f","404":"bf6963ee-0a8f-4a09-92cb-633c96a1f763","409":"8f80ee86-c02a-4b36-bff8-3d98f2f64613"},"method":"post","type":"path","servers":["a5156da9-85be-4cc8-a520-0d5313277e3d"],"security":["6cb7daae-10aa-45ec-8632-c332b7d5b059"],"path":"/saved-snapshots","baseUrlOptions":["https://boat.dev/api/v1"],"title":"Save a saved snapshot","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sandboxId","name"],"properties":{"sandboxId":{"type":"string","description":"The sandbox whose current state to freeze.","isRequired":true,"uniqueKey":"sandboxId","typeLabel":"string"},"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$","description":"Name to save under. 1-63 lowercase letters, digits, or dashes, starting with a letter or digit. Reusing one of your existing names replaces that snapshot's artifact. `latest`, `tree`, `pull`, `rm`, `save`, `current`, `self`, and `new` are reserved.","isRequired":true,"uniqueKey":"name","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"sandboxId":"\u003cstring>","name":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"14723766-0ac5-4d66-8223-e65fd22a5c15":{"description":"Save accepted and running in the background.","content":{"application/json":{"schema":{"type":"object","required":["status","snapshot","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.","const":"snapshot.saved.saving","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"status":{"type":"string","const":"saving","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"snapshot":{"type":"object","description":"A saved snapshot: a frozen copy of a sandbox's disk at one moment, saved under a name you pick. Independent of the source sandbox's later life: the sandbox can change, stop, or be deleted and the saved snapshot still deploys. Saved snapshots never expire; re-saving a name replaces its artifact.","required":["name","status","sourceSandboxId","createdAt"],"properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,62}$","description":"The user-chosen handle, unique within your account.","isRequired":true,"uniqueKey":"snapshot.name","typeLabel":"string"},"status":{"type":"string","enum":["saving","ready","failed"],"description":"`saving` while the capture and pin are in flight (a live source sandbox takes a fresh snapshot first, which can run minutes), `ready` when deployable, `failed` if the save did not complete (see `error`; save again to retry).","isRequired":true,"uniqueKey":"snapshot.status","typeLabel":"enum\u003cstring>"},"sourceSandboxId":{"type":"string","description":"The sandbox this snapshot was saved from (display only).","isRequired":true,"uniqueKey":"snapshot.sourceSandboxId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"snapshot.createdAt","typeLabel":"string\u003cdate-time>"},"error":{"type":"string","description":"Failure reason. Only present when `status` is `failed`.","uniqueKey":"snapshot.error","typeLabel":"string"},"snapshotId":{"type":"string","description":"The frozen artifact behind the name. Present once `status` is `ready`. Accepted by `GET /api/boat/snapshots/{snapshotId}/tree` to browse its files.","uniqueKey":"snapshot.snapshotId","typeLabel":"string"},"type":{"type":"string","description":"Sandbox type the snapshot was saved from. Deploys default to it.","uniqueKey":"snapshot.type","typeLabel":"string"},"sizeBytes":{"type":"integer","description":"Restored content size of the frozen state, in bytes.","uniqueKey":"snapshot.sizeBytes","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"snapshot","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"type":"snapshot.saved.saving","status":"saving","snapshot":{"name":"\u003cstring>","status":"saving","sourceSandboxId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","error":"\u003cstring>","snapshotId":"\u003cstring>","type":"\u003cstring>","sizeBytes":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"3647a19e-b1c5-4cd7-92ab-13a3cdb93f29":{"description":"Invalid request body or parameters.","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":{"invalid":{"title":"invalid","value":{"ok":false,"type":"sandbox.error","status":400,"code":"invalid_json","message":"Request body must be valid JSON.","error":{"code":"invalid_json","message":"Request body must be valid JSON.","status":400},"requestId":"req_01HX..."}}},"exampleType":"examples"}},"exampleType":"examples"},"773fbad1-506a-4fbb-a829-e211e9084a06":{"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"},"cff168aa-f329-4afe-adb6-af8ab73fef0f":{"description":"`credit_required`: the wallet already keeps its included saved snapshots and is empty. Each saved snapshot above the plan's included count costs $0.056 a day from the wallet. Add money to the wallet or remove one.","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"},"bf6963ee-0a8f-4a09-92cb-633c96a1f763":{"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"},"8f80ee86-c02a-4b36-bff8-3d98f2f64613":{"description":"`save_in_progress` when a save under this name is already running; wait for it to settle rather than retrying immediately.","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":{"6cb7daae-10aa-45ec-8632-c332b7d5b059":{"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":{"a5156da9-85be-4cc8-a520-0d5313277e3d":{"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":"Save a saved snapshot - boat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T11:52:13.595Z","originalFileLocation":"api/reference/snapshots/save-saved-snapshot.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=\"Freeze a sandbox\u0026#x27;s current state under a name (boat snapshot in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot\u0026#x27;s artifact once the new save is ready.\">\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=\"Save a saved snapshot - boat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Freeze a sandbox\u0026#x27;s current state under a name (boat snapshot in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot\u0026#x27;s artifact once the new save is ready.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"boat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ariana-1e97e6c3.mintlify.site/_mintlify/api/og/v2?division=Saved+snapshots\u0026amp;title=Save+a+saved+snapshot\u0026amp;description=Freeze+a+sandbox%27s+current+state+under+a+name+%28%60boat+snapshot+%3Cid%3E+%3Cname%3E%60+in+the+CLI%29.+Answers+%60202%60+immediately+with+the+snapshot+in+%60saving%60%3B+a+running+sandb\u0026amp;theme=fbfc18691897550a6350a98a\u0026amp;signature=a4aab44ba98cc77766257f81e3b0f457c3d4c8a2a8cb75e69fecf55383b7c9ee\">\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=\"Save a saved snapshot - boat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Freeze a sandbox\u0026#x27;s current state under a name (boat snapshot in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot\u0026#x27;s artifact once the new save is ready.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ariana-1e97e6c3.mintlify.site/_mintlify/api/og/v2?division=Saved+snapshots\u0026amp;title=Save+a+saved+snapshot\u0026amp;description=Freeze+a+sandbox%27s+current+state+under+a+name+%28%60boat+snapshot+%3Cid%3E+%3Cname%3E%60+in+the+CLI%29.+Answers+%60202%60+immediately+with+the+snapshot+in+%60saving%60%3B+a+running+sandb\u0026amp;theme=fbfc18691897550a6350a98a\u0026amp;signature=a4aab44ba98cc77766257f81e3b0f457c3d4c8a2a8cb75e69fecf55383b7c9ee\">\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/snapshots/save-saved-snapshot\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/reference/snapshots/save-saved-snapshot.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://boat.dev/#organization\",\"name\":\"boat\",\"legalName\":\"Dedale AI, Corp.\",\"url\":\"https://boat.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://boat.dev/apple-touch-icon.png\"},\"sameAs\":[\"https://x.com/boatdotdev\",\"https://www.linkedin.com/company/boatdotdev\",\"https://github.com/ariana-dot-dev\",\"https://discord.com/invite/Y3TFTmE89g\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.boat.dev#website\",\"name\":\"boat\",\"url\":\"https://docs.boat.dev\",\"publisher\":{\"@id\":\"https://boat.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot#webpage\",\"url\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot\",\"name\":\"Save a saved snapshot\",\"description\":\"Freeze a sandbox's current state under a name (boat snapshot in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot's artifact once the new save is ready.\",\"dateModified\":\"2026-10-23T11:52:13.595Z\",\"isPartOf\":{\"@id\":\"https://docs.boat.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Saved snapshots\",\"item\":\"https://docs.boat.dev/api/reference/snapshots/list-saved-snapshots\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Save a saved snapshot\",\"item\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot#apireference\",\"headline\":\"Save a saved snapshot\",\"name\":\"Save a saved snapshot\",\"description\":\"Freeze a sandbox's current state under a name (boat snapshot in the CLI). Answers 202 immediately with the snapshot in saving; a running sandbox takes a fresh capture first, which can run minutes. Poll GET /saved-snapshots/{name} until the status settles at ready or failed. Reusing one of your existing names replaces that snapshot's artifact once the new save is ready.\",\"url\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot\",\"mainEntityOfPage\":{\"@id\":\"https://docs.boat.dev/api/reference/snapshots/save-saved-snapshot#webpage\"},\"dateModified\":\"2026-10-23T11:52:13.595Z\",\"publisher\":{\"@id\":\"https://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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"boat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/reference/snapshots/save-saved-snapshot.md","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","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","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","description":"List your saved snapshots, newest first. An unknown query parameter is refused with `400 invalid_query`, which names it.","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","description":"Get a saved snapshot and its status. Poll this after saving one until the status settles at ready or failed.","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":"Save a saved snapshot - boat","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-DRLI_2Ue.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}