{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Documentation","description":"Blaxel documentation: cloud sandboxes, AI agent hosting, MCP servers, batch jobs, and model gateway for building and deploying AI-powered applications.","colors":{"primary":"#F0652D","light":"#FD7B35","dark":"#F0652D"},"logo":{"light":"https://mintcdn.com/blaxel/Z-RIT2VoXMT2Aw7L/images/logo-light.svg?fit=max\u0026auto=format\u0026n=Z-RIT2VoXMT2Aw7L\u0026q=85\u0026s=7a7cf1e3c766c77f97f32e5c0d4fd209","dark":"https://mintcdn.com/blaxel/Z-RIT2VoXMT2Aw7L/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=Z-RIT2VoXMT2Aw7L\u0026q=85\u0026s=17297eca3e92fe15a91eed262f17d659"},"favicon":"https://mintcdn.com/blaxel/nH6Nd4qmP2OsLhOO/favicon.svg?fit=max\u0026auto=format\u0026n=nH6Nd4qmP2OsLhOO\u0026q=85\u0026s=484b8f0ebe3fb56aef259d514eeaa18c","appearance":{"default":"system"},"background":{"color":{"dark":"#09090B"}},"navbar":{"links":[{"icon":"calendar","href":"/changelog","label":"Changelog"},{"icon":"robot","href":"/skills-mcp","label":"Agent Skill"},{"icon":"puzzle-piece","href":"https://blaxel.ai/integrations","label":"Integrations"},{"icon":"discord","href":"/Community","label":"Community"}],"primary":{"type":"button","label":"Blaxel Console","href":"https://app.blaxel.ai"}},"footer":{"socials":{"github":"https://github.com/blaxel-ai","linkedin":"https://www.linkedin.com/company/blaxel-ai","twitter":"https://x.com/blaxelai","discord":"https://discord.gg/CsWKUZUHFQ"}},"search":{"prompt":"Search Blaxel docs..."},"seo":{"metatags":{"og:type":"website","og:site_name":"Blaxel Documentation"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_HGJ7t7Qa8cJJilL0CONU5se4vM6jU6nKFCuoCC9LSha","apiHost":"https://events.blaxel.ai"}},"banner":{"content":"Blaxel has joined Baseten to build the future of agentic infrastructure! [Read our announcement.](https://www.baseten.co/blog/blaxel-is-joining-baseten-to-build-the-future-of-agentic-cloud/)","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","devin","download-spec"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"calendar","href":"/changelog"},{"anchor":"Blaxel Skills \u0026 MCP","icon":"robot","href":"/skills-mcp"},{"anchor":"Integrations directory","icon":"puzzle-piece","href":"https://blaxel.ai/integrations"},{"anchor":"Community","icon":"discord","href":"/Community"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"blaxel","hasAudioNarration":false,"actualSubdomain":"blaxel","customDomains":["docs.blaxel.ai"],"gitSource":{"type":"github","owner":"blaxel-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3fd9d39d5c86a21f7dc2b","collectionId":"857fa55e-77d4-4e24-b81e-4190e709f519","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3fd9d39d5c86a21f7dc2b"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae3fd9d39d5c86a21f7dc2b","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Platform APIs Reference","count":179},{"language":"default","tag":"Management API","count":176},{"language":"default","tag":"Documentation","count":114},{"language":"default","tag":"Overview","count":75},{"language":"default","tag":"CLI Reference","count":73},{"language":"default","tag":"Commands","count":72},{"language":"default","tag":"Sandbox API Reference","count":42},{"language":"default","tag":"Troubleshooting","count":41},{"language":"default","tag":"Tutorials and Examples","count":35},{"language":"default","tag":"compute","count":35}]},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@blaxel.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar .nav-logo{height:2.5rem;width:auto}#navbar:has(#banner){display:flex;flex-direction:column}#navbar:has(#banner)>.max-w-8xl{width:100%}#navbar:has(#banner)>div[aria-hidden=true]{display:none}#banner{position:relative;inset:auto;order:1;padding:1.25rem 3rem;background:0 0;font-size:.9375rem;font-weight:400}#banner>div{width:100%;max-width:70rem;margin:0;padding:1rem 3.5rem 1rem 1.75rem;border:1px solid #394655;border-radius:.75rem;background:radial-gradient(ellipse at 50% 0,rgb(99 216 226/12%),transparent 70%),linear-gradient(110deg,#121b29,#081827 52%,#141925);box-shadow:0 12px 32px -16px rgb(7 11 17/40%),inset 0 1px 0 rgb(255 255 255/5%)}#banner>button{right:max(4rem,calc((100% - 70rem)/2 + 1rem))}#banner p{color:#dbdbdb!important;line-height:1.5}#banner a{display:inline-flex;align-items:center;gap:.5rem;margin-left:.75rem;color:#fff!important;text-decoration:none;white-space:nowrap}#banner a::after{content:\"\";width:1.25rem;height:1.25rem;background-color:#eb7229;mask:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 18 18' fill='none' stroke='black' stroke-width='1.25' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M3 9h12M10 4l5 5-5 5'/%3E%3C/svg%3E\") center/contain no-repeat}#banner a:hover{text-decoration:underline;text-decoration-color:#fff}#banner a:focus-visible{border-radius:2px;outline:2px solid #eb7229;outline-offset:4px}@media (max-width:767px){#banner{padding:1rem;text-align:left}#banner>div{padding:1rem 2.75rem 1rem 1rem}#banner a{display:flex;width:fit-content;margin:.375rem 0 0}#banner>button{top:1.75rem;right:1.75rem;transform:none}}"}],"page":{"pagePath":"api-reference","slug":"/api-reference","pageMetadata":{"title":"API reference index","description":"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.","href":"/api-reference"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.a,{href:`api-reference/introduction`,children:`introduction`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`api-reference/inference`,children:`inference`})}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`api-reference/billing`,children:`billing`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API reference index","description":"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.","href":"/api-reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"blaxel","siteName":"Documentation","title":"API reference index - Documentation","contextualStarterQuestions":[{"_id":"6a057b94071845739ab60104","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"What inference endpoints are available?","status":"active","generatedBy":"contextual","path":"api-reference","createdAt":"2026-05-14T07:36:52.351Z","updatedAt":"2026-05-14T07:36:52.351Z","__v":0},{"_id":"6a057b94071845739ab60105","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"How do I access billing data?","status":"active","generatedBy":"contextual","path":"api-reference","createdAt":"2026-05-14T07:36:52.351Z","updatedAt":"2026-05-14T07:36:52.351Z","__v":0},{"_id":"6a057b94071845739ab60103","deploymentId":"672e5f6ba9a398341da2aaec","questionText":"How do I authenticate API requests?","status":"active","generatedBy":"contextual","path":"api-reference","createdAt":"2026-05-14T07:36:52.351Z","updatedAt":"2026-05-14T07:36:52.351Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-14T07:36:33.491Z","gitLastModified":"2026-05-14T07:36:08.000Z","originalFileLocation":"api-reference.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=\"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_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/blaxel/uaLoRkh_ONjRStCE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API reference index - Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Blaxel Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.blaxel.ai/api-reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://blaxel.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+reference+index\u0026amp;description=Index+of+Blaxel+API+reference+pages+covering+authentication%2C+the+inference+API+for+deployed+workloads%2C+and+the+Billing+Explorer+API+endpoints.\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=5a85a3aa938944f8d8fafff2fefc7ef4aeb37d2c97e9ed66fbfbccd11445b9aa\">\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=\"API reference index - Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Index of Blaxel API reference pages covering authentication, the inference API for deployed workloads, and the Billing Explorer API endpoints.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://blaxel.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=API+reference+index\u0026amp;description=Index+of+Blaxel+API+reference+pages+covering+authentication%2C+the+inference+API+for+deployed+workloads%2C+and+the+Billing+Explorer+API+endpoints.\u0026amp;theme=2ee6a4a0c0526ef8591d7c25\u0026amp;signature=5a85a3aa938944f8d8fafff2fefc7ef4aeb37d2c97e9ed66fbfbccd11445b9aa\">\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/blaxel/uaLoRkh_ONjRStCE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F0652D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.blaxel.ai/api-reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"calendar","href":"/changelog"},{"anchor":"Blaxel Skills \u0026 MCP","icon":"robot","href":"/skills-mcp"},{"anchor":"Integrations directory","icon":"puzzle-piece","href":"https://blaxel.ai/integrations"},{"anchor":"Community","icon":"discord","href":"/Community"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Get Started","pages":[{"title":"Blaxel: infrastructure for autonomous agents","sidebarTitle":"Overview","href":"/Overview"},{"title":"Get started","href":"/Get-started"},{"title":"Blaxel Skills \u0026 MCP","icon":"robot","href":"/skills-mcp"},{"title":"Community","sidebarTitle":"Community","href":"/Community"}]},{"group":"Sandboxes","pages":[{"title":"Sandboxes","sidebarTitle":"Overview","href":"/Sandboxes/Overview"},{"group":"Expiration policies","pages":[{"title":"Expiration policies","href":"/Sandboxes/Expiration"},{"title":"Lifecycle signals","href":"/Sandboxes/Lifecycle-signals"}]},{"title":"Process execution","href":"/Sandboxes/Processes"},{"group":"File system","pages":[{"title":"File system","sidebarTitle":"Overview","href":"/Sandboxes/Filesystem"},{"title":"Code generation tools","href":"/Sandboxes/Codegen-tools"}]},{"title":"Log streaming","href":"/Sandboxes/Log-streaming"},{"title":"Snapshots and forking","sidebarTitle":"Snapshots \u0026 forking","tag":"private preview","href":"/Sandboxes/Fork"},{"title":"Archive and unarchive sandboxes","sidebarTitle":"Archive","tag":"private preview","href":"/Sandboxes/Archive"},{"group":"Ports, previews \u0026 sessions","pages":[{"title":"Ports","href":"/Sandboxes/Ports"},{"title":"Real-time previews","href":"/Sandboxes/Preview-url"},{"title":"Handle CORS on Blaxel","sidebarTitle":"CORS","href":"/Sandboxes/CORS"},{"title":"Client-side sessions","href":"/Sandboxes/Sessions"},{"title":"Standby control","href":"/Sandboxes/Standby-control"}]},{"title":"Sandbox schedules","sidebarTitle":"Schedule","href":"/Sandboxes/Schedules"},{"group":"Proxy","pages":[{"title":"Proxy","tag":"public preview","href":"/Sandboxes/Proxy"},{"title":"Proxy routing with secrets injection","tag":"public preview","href":"/Sandboxes/Proxy-secrets-injection"},{"title":"Domain filtering","tag":"public preview","href":"/Sandboxes/Proxy-domains"}]},{"title":"Volumes for sandboxes","sidebarTitle":"Volumes","href":"/Sandboxes/Volumes"},{"title":"Build reusable sandbox images with Dockerfiles","sidebarTitle":"Images","href":"/Sandboxes/Templates"},{"title":"Run sandbox workloads as a non-root user","sidebarTitle":"Non-root user","href":"/Sandboxes/Non-root-user"},{"title":"Sandbox variables and secrets","sidebarTitle":"Variables \u0026 secrets","href":"/Sandboxes/Variables-and-secrets"},{"title":"Sandbox MCP server","sidebarTitle":"MCP server","href":"/Sandboxes/MCP"},{"title":"Sandbox best practices","sidebarTitle":"Best practices","href":"/Sandboxes/best-practices"}]},{"group":"Agent Drive","pages":[{"title":"Agent Drive overview","sidebarTitle":"Overview","tag":"private preview","href":"/Agent-drive/Overview"},{"title":"Drive permissions","sidebarTitle":"Permissions","tag":"private preview","href":"/Agent-drive/Permissions"},{"title":"Access Agent Drive over S3","sidebarTitle":"S3 endpoint","tag":"private preview","href":"/Agent-drive/S3-endpoint"}]},{"group":"Volumes","pages":[{"title":"Volumes","sidebarTitle":"Overview","href":"/Volumes/Overview"},{"title":"Volume templates","href":"/Volumes/Volumes-templates"}]},{"group":"Batch Jobs","pages":[{"title":"Jobs","sidebarTitle":"Overview","href":"/Jobs/Overview"},{"title":"Develop a job","href":"/Jobs/Develop-a-job"},{"group":"Deploy a job","pages":[{"title":"Deploy jobs","href":"/Jobs/Deploy-a-job"},{"title":"Deploy jobs with a Dockerfile","sidebarTitle":"Deploy with a Dockerfile","href":"/Jobs/Deploy-dockerfile-jobs"},{"title":"Deploy multiple jobs from a mono-repo","sidebarTitle":"Deploy multiple resources","href":"/Jobs/Deploy-multiple-jobs"},{"title":"Deploy multiple jobs from a single image","href":"/Jobs/Deploy-shared-image"}]},{"group":"Manage job execution","pages":[{"title":"Manage job execution in TypeScript","href":"/Jobs/Manage-job-execution-ts"},{"title":"Manage job execution in Python","href":"/Jobs/Manage-job-execution-py"}]},{"title":"Variables and secrets for jobs","sidebarTitle":"Variables and secrets","href":"/Jobs/Variables-and-secrets-jobs"}]},{"group":"Applications","pages":[{"title":"Applications","sidebarTitle":"Overview","tag":"private preview","href":"/Applications/Overview"}]},{"group":"MCP Servers Hosting","pages":[{"title":"MCP servers","sidebarTitle":"Overview","href":"/Functions/Overview"},{"title":"Quickstart: Adapt an existing MCP server for Blaxel","href":"/Functions/Adapt-Existing-MCP-server"},{"title":"Quickstart: Develop a custom MCP server","href":"/Functions/Create-MCP-server"},{"title":"Deploy custom MCP servers","href":"/Functions/Deploy-a-function"},{"title":"Query MCP servers","href":"/Functions/Invoke-functions"},{"title":"Code mode","href":"/Functions/Code-mode"},{"title":"Variables and secrets for MCP servers","sidebarTitle":"Variables and secrets","href":"/Functions/Variables-and-secrets"},{"title":"OAuth flow for integrations","href":"/Functions/oauth-flow"}]},{"group":"Model Gateway","pages":[{"title":"Model APIs","sidebarTitle":"Overview","href":"/Models/Overview"},{"title":"External model APIs","href":"/Models/External-model-apis"},{"title":"Query a model API","href":"/Models/Query-a-model"}]},{"group":"Observability","pages":[{"title":"Logs \u0026 traces","href":"/Observability/Overview"}]},{"group":"Integrations","pages":[{"title":"Integrations","sidebarTitle":"Overview","href":"/Integrations"},{"group":"Model providers integrations","pages":[{"title":"OpenAI integration","href":"/Integrations/OpenAI"},{"title":"Anthropic integration","href":"/Integrations/Anthropic"},{"title":"Mistral AI integration","href":"/Integrations/MistralAI"},{"title":"Cohere integration","href":"/Integrations/Cohere"},{"title":"xAI integration","href":"/Integrations/xAI"},{"title":"DeepSeek integration","href":"/Integrations/DeepSeek"},{"title":"HuggingFace integration","href":"/Integrations/HuggingFace"},{"title":"Azure AI Foundry integration","href":"/Integrations/Azure-AI-Foundry"}]},{"group":"MCP server integrations","pages":[{"title":"Google Maps","href":"/Integrations/Google-Maps"},{"title":"Gmail","href":"/Integrations/Gmail"}]},{"group":"Agent frameworks and tools","pages":[{"title":"OpenAI Agents API on Blaxel","sidebarTitle":"OpenAI Agents API","href":"/Integrations/OpenAI-Agents-API"},{"title":"AgentMail","href":"/Integrations/AgentMail"},{"title":"Rippletide","href":"/Integrations/Rippletide"}]}]},{"group":"Administration \u0026 security","pages":[{"group":"Workspaces and permissions","pages":[{"title":"Workspaces, users and roles","href":"/Security/Workspace-access-control"},{"title":"Baseten managed workspaces","href":"/Security/Baseten-managed-workspaces"},{"title":"Service accounts","href":"/Security/Service-accounts"}]},{"title":"Access tokens","href":"/Security/Access-tokens"},{"title":"Billing Explorer API","href":"/Security/Billing-Explorer-API"},{"group":"Identity \u0026 Access","pages":[{"title":"Domain capture","href":"/Security/Domain-capture"},{"title":"SAML \u0026 Directory Sync","tag":"preview","href":"/Security/SSO-Directory-sync"}]},{"title":"Usage and quotas","href":"/Security/Quotas"},{"title":"Data collection and privacy","href":"/Security/Data-collection-and-privacy"},{"title":"Policies","href":"/Model-Governance/Policies"},{"group":"Infrastructure","pages":[{"title":"Regions","href":"/Infrastructure/Regions"},{"title":"Generations","href":"/Infrastructure/Gens"},{"title":"Dedicated egress gateways","tag":"private preview","href":"/Infrastructure/Dedicated-egress-gateways"},{"title":"Custom domains","href":"/Infrastructure/Custom-domains"},{"title":"HTTP validation","tag":"private preview","href":"/Infrastructure/Custom-domains-http-validation"}]}]},{"group":"Troubleshooting","pages":[{"title":"Troubleshoot Blaxel deployments, runtime, and CLI errors","sidebarTitle":"Troubleshoot common errors","href":"/troubleshooting"},{"title":"Error codes reference","href":"/troubleshooting/error-codes"},{"group":"Knowledge base","pages":[{"title":"Knowledge Base","sidebarTitle":"Overview","href":"/knowledge-base/overview"},{"group":"Integrations","pages":[{"title":"Set up Next.js with Blaxel Sandboxes","href":"/knowledge-base/integrations/setting-up-nextjs-with-blaxel-sandboxes"},{"title":"Set up Astro with Blaxel Sandboxes","href":"/knowledge-base/integrations/setting-up-astro-with-blaxel-sandboxes"},{"title":"Set up Vite with Blaxel Sandboxes","href":"/knowledge-base/integrations/setting-up-vite-with-blaxel-sandboxes"},{"title":"Set up Expo with Blaxel Sandboxes","href":"/knowledge-base/integrations/setting-up-expo-with-blaxel-sandboxes"}]},{"group":"Configuration and Operation","pages":[{"title":"Using custom domains with sandboxes","href":"/knowledge-base/configuration-and-operation/using-custom-domains-with-sandboxes"},{"title":"Getting static IP addresses for Blaxel sandboxes","href":"/knowledge-base/configuration-and-operation/getting-static-ip-addresses-for-blaxel-sandboxes"},{"title":"Understanding sandbox active vs standby states and billing","href":"/knowledge-base/configuration-and-operation/understanding-sandbox-active-vs-standby-states-and-billing"},{"title":"Understanding sandbox TTL and expiration policies","href":"/knowledge-base/configuration-and-operation/understanding-sandbox-ttl-and-expiration-policies"},{"title":"Use template names instead of image IDs when creating sandboxes","href":"/knowledge-base/configuration-and-operation/use-template-names-instead-of-image-id-when-creating-sandboxes"},{"title":"Ensure sandboxes use the latest deployed image","href":"/knowledge-base/configuration-and-operation/ensure-sandboxes-use-the-latest-deployed-image"},{"title":"Volume resizing for running sandboxes","href":"/knowledge-base/configuration-and-operation/volume-resizing-for-running-sandboxes"},{"title":"Sandbox inactivity with long-running processes","href":"/knowledge-base/configuration-and-operation/sandbox-inactivity-with-long-running-processes"},{"title":"Batch delete sandboxes from the CLI","href":"/knowledge-base/configuration-and-operation/batch-delete-sandboxes-from-the-cli"}]},{"group":"Security and Authentication","pages":[{"title":"Setting up MCP servers with authentication on Blaxel","href":"/knowledge-base/security-and-authentication/setting-up-mcp-servers-with-authentication-on-blaxel"},{"title":"Multi-Factor Authentication (MFA) and compliance requirements","href":"/knowledge-base/security-and-authentication/multi-factor-authentication-mfa-and-compliance-requirements"},{"title":"How to authenticate the Blaxel CLI in CI environments","href":"/knowledge-base/security-and-authentication/how-to-authenticate-the-bl-cli-in-ci-environments"}]},{"group":"Troubleshooting","pages":[{"title":"Resolving sandbox creation issues","href":"/knowledge-base/troubleshooting/resolving-sandbox-creation-issues"},{"title":"Resolving sandbox creation race conditions and duplicate requests","href":"/knowledge-base/troubleshooting/resolving-sandbox-creation-race-conditions-and-duplicate-requests"},{"title":"Troubleshooting custom Docker image deployment issues","href":"/knowledge-base/troubleshooting/troubleshooting-custom-docker-image-deployment-issues"},{"title":"Sandbox limits and quota exceeded errors","href":"/knowledge-base/troubleshooting/sandbox-limits-and-quota-exceeded-errors"},{"title":"WebSocket connection timeouts and the 15-minute limit","href":"/knowledge-base/troubleshooting/websocket-connection-timeouts-and-15-minute-limit"},{"title":"Handling Preview not found 404 errors in sandboxes","href":"/knowledge-base/troubleshooting/handling-preview-not-found-404-errors-in-sandboxes"},{"title":"Resolving sandbox restarts caused by nc not found","href":"/knowledge-base/troubleshooting/sandbox-restarting-nc-not-found"},{"title":"When localhost goes silent in Debian-based sandboxes","href":"/knowledge-base/troubleshooting/when-localhost-goes-silent-in-debian-based-sandboxes"},{"title":"Fix Miniflare inspector startup failures on Carbon sandboxes","href":"/knowledge-base/troubleshooting/miniflare-inspector-startup-failures-on-carbon"},{"title":"SSL certificate verification errors when cloning repositories","href":"/knowledge-base/troubleshooting/ssl-certificate-verification-errors-when-cloning-repositories"},{"title":"Resolving ENOSPC no space left on device errors","href":"/knowledge-base/troubleshooting/resolve-enospc-no-space-left-on-device-errors"}]}]}]}]},{"tab":"Tutorials and Examples","pages":[{"title":"Tutorials and examples overview","sidebarTitle":"Overview","href":"/Tutorials/Overview"},{"group":"Popular templates","pages":[{"group":"Claude","expanded":true,"pages":[{"title":"Self-host Claude Managed Agents on Blaxel","href":"/Tutorials/Claude-Managed-Agents"},{"title":"Run Claude Code in a sandbox","href":"/Tutorials/Claude-Code"},{"group":"Advanced examples","pages":[{"title":"Use Claude Agent SDK with Blaxel","sidebarTitle":"Overview","href":"/Tutorials/Claude-Agent-SDK-Index"},{"title":"Connect Claude Agent SDK to sandboxes","sidebarTitle":"Connect from Claude Agent SDK","href":"/Tutorials/Claude-Agent-SDK-MCP"},{"title":"Use Claude Agent SDK with MCP Code Mode","href":"/Tutorials/Claude-Agent-SDK-Code-Mode"},{"title":"Deploy Claude Agent SDK agents on Blaxel","href":"/Tutorials/Claude-Agent-SDK"}]}]},{"group":"OpenAI / Codex","pages":[{"title":"Run Codex in a sandbox","href":"/Tutorials/Codex"},{"title":"Give an OpenAI agent a computer and keep its work","sidebarTitle":"OpenAI Agents API","href":"/Tutorials/OpenAI-Agents-API"},{"title":"Use OpenAI Agents SDK with sandboxes","sidebarTitle":"Connect from OpenAI Agents SDK","href":"/Tutorials/OpenAI-Agents-SDK"},{"title":"Deploy OpenAI Agents SDK on Blaxel","href":"/Tutorials/OpenAI-Agents-SDK-Deployment"}]},{"group":"Amp","pages":[{"title":"Run Amp in a sandbox","href":"/Tutorials/Amp"}]},{"title":"All full repo examples","href":"/Examples/Overview"}]},{"group":"Sandboxes","expanded":true,"pages":[{"title":"Sandbox application tutorials overview","href":"/Tutorials/Sandboxes-Overview"},{"title":"Run Astro in a sandbox","href":"/Tutorials/Astro"},{"title":"Run Expo in a sandbox","href":"/Tutorials/Expo"},{"title":"Run Next.js in a sandbox","href":"/Tutorials/Nextjs"},{"title":"Run code-server in a sandbox","href":"/Tutorials/Code-server"},{"title":"Run Docker in a sandbox","href":"/Tutorials/Docker"},{"title":"Run Tailscale in a sandbox","href":"/Tutorials/Tailscale"}]},{"group":"Agent harness","expanded":true,"pages":[{"title":"Agent framework tutorials overview","href":"/Tutorials/Agents-Overview"},{"title":"Run Omnara agents in Blaxel sandboxes","sidebarTitle":"Omnara on Blaxel","href":"/Tutorials/Omnara"},{"title":"Run NVIDIA OpenShell on Blaxel","sidebarTitle":"NVIDIA OpenShell on Blaxel","href":"/Tutorials/OpenShell"},{"title":"Continue DeepSeek Harness sessions in a Blaxel sandbox","sidebarTitle":"DeepSeek Harness on Blaxel","href":"/Tutorials/DeepSeek-Harness"},{"title":"Run coding agents in Blaxel sandboxes from Herdr","sidebarTitle":"Herdr on Blaxel","href":"/Tutorials/Herdr"},{"title":"Run OpenClaw on Blaxel","href":"/Tutorials/OpenClaw"},{"title":"Run AI SDK on Blaxel","href":"/Tutorials/Vercel-AI"},{"title":"Use Mastra agents with Blaxel","href":"/Tutorials/Mastra"},{"title":"Run LangChain on Blaxel","href":"/Tutorials/LangChain"},{"title":"Run CrewAI on Blaxel","href":"/Tutorials/CrewAI"},{"title":"Run Google ADK on Blaxel","href":"/Tutorials/ADK"},{"title":"Run LlamaIndex on Blaxel","href":"/Tutorials/LlamaIndex"},{"title":"Run PydanticAI on Blaxel","href":"/Tutorials/PydanticAI"},{"title":"Orchestrate Blaxel agents with n8n","href":"/Tutorials/n8n"},{"title":"Run custom agents on Blaxel","href":"/Tutorials/Custom-Agents"}]}]},{"tab":"Platform APIs Reference","groups":[{"group":"Overview","pages":[{"title":"REST API overview","sidebarTitle":"Overview","href":"/api-reference/introduction"}]},{"group":"Inference API","pages":[{"title":"Inference API","href":"/api-reference/inference"}]},{"group":"Billing API","pages":[{"title":"Billing API endpoint reference","href":"/api-reference/billing"}]},{"group":"Management API","pages":[{"group":"agents","pages":[{"title":"List all agents","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents","href":"/api-reference/agents/list-all-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents/{agentName}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /agents/{agentName}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /agents/{agentName}","href":"/api-reference/agents/delete-agent"},{"title":"List all agent revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /agents/{agentName}/revisions","href":"/api-reference/agents/list-all-agent-revisions"}]},{"group":"applications","pages":[{"title":"List all applications","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications","href":"/api-reference/applications/list-all-applications"},{"title":"Create application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /applications","href":"/api-reference/applications/create-application"},{"title":"Get application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications/{applicationName}","href":"/api-reference/applications/get-application"},{"title":"Update application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /applications/{applicationName}","href":"/api-reference/applications/update-application"},{"title":"Delete application","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /applications/{applicationName}","href":"/api-reference/applications/delete-application"},{"title":"List all application revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /applications/{applicationName}/revisions","href":"/api-reference/applications/list-all-application-revisions"}]},{"group":"customdomains","pages":[{"title":"Create application custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /applications/{applicationName}/customdomains","href":"/api-reference/customdomains/create-application-custom-domain"},{"title":"List custom domains","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains","href":"/api-reference/customdomains/list-custom-domains"},{"title":"Create custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains","href":"/api-reference/customdomains/create-custom-domain"},{"title":"Get custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains/{domainName}","href":"/api-reference/customdomains/get-custom-domain"},{"title":"Update custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /customdomains/{domainName}","href":"/api-reference/customdomains/update-custom-domain"},{"title":"Delete custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /customdomains/{domainName}","href":"/api-reference/customdomains/delete-custom-domain"},{"title":"List custom domain shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /customdomains/{domainName}/share","href":"/api-reference/customdomains/list-custom-domain-shares"},{"title":"Share a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains/{domainName}/share","href":"/api-reference/customdomains/share-a-custom-domain"},{"title":"Unshare a custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /customdomains/{domainName}/share/{targetWorkspace}","href":"/api-reference/customdomains/unshare-a-custom-domain"},{"title":"Verify custom domain","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /customdomains/{domainName}/verify","href":"/api-reference/customdomains/verify-custom-domain"}]},{"group":"changelog","pages":[{"title":"Get latest changelog entries","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /changelog","href":"/api-reference/changelog/get-latest-changelog-entries"}]},{"group":"configurations","pages":[{"title":"Get platform configuration","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /configuration","href":"/api-reference/configurations/get-platform-configuration"}]},{"group":"drives","pages":[{"title":"List drives","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives","href":"/api-reference/drives/list-drives"},{"title":"Create a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /drives","href":"/api-reference/drives/create-a-drive"},{"title":"Get a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/{driveName}","href":"/api-reference/drives/get-a-drive"},{"title":"Update a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /drives/{driveName}","href":"/api-reference/drives/update-a-drive"},{"title":"Delete a drive","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /drives/{driveName}","href":"/api-reference/drives/delete-a-drive"},{"title":"Create drive access token","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /drives/{driveName}/access-token","href":"/api-reference/drives/create-drive-access-token"},{"title":"Delete a folder and its contents","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /drives/{driveName}/folders","href":"/api-reference/drives/delete-a-folder-and-its-contents"},{"title":"Get drive by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/by-external-id/{externalId}","href":"/api-reference/drives/get-drive-by-external-id"},{"title":"Get drive token JWKS","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /drives/jwks.json","href":"/api-reference/drives/get-drive-token-jwks"}]},{"group":"vpcs","pages":[{"title":"List all egress gateways across all VPCs in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressgateways","href":"/api-reference/vpcs/list-all-egress-gateways-across-all-vpcs-in-the-workspace"},{"title":"Egress gateway sandbox attachments","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressgateways/usage","href":"/api-reference/vpcs/egress-gateway-sandbox-attachments"},{"title":"List all egress IPs across all VPCs and gateways in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /egressips","href":"/api-reference/vpcs/list-all-egress-ips-across-all-vpcs-and-gateways-in-the-workspace"},{"title":"List all VPCs in the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs","href":"/api-reference/vpcs/list-all-vpcs-in-the-workspace"},{"title":"Create a VPC for the workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs","href":"/api-reference/vpcs/create-a-vpc-for-the-workspace"},{"title":"Get a VPC by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}","href":"/api-reference/vpcs/get-a-vpc-by-name"},{"title":"Delete a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}","href":"/api-reference/vpcs/delete-a-vpc"},{"title":"List egress gateways in a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways","href":"/api-reference/vpcs/list-egress-gateways-in-a-vpc"},{"title":"Create an egress gateway in a VPC","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs/{vpcName}/egressgateways","href":"/api-reference/vpcs/create-an-egress-gateway-in-a-vpc"},{"title":"Get an egress gateway by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}","href":"/api-reference/vpcs/get-an-egress-gateway-by-name"},{"title":"Delete an egress gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}/egressgateways/{gatewayName}","href":"/api-reference/vpcs/delete-an-egress-gateway"},{"title":"List egress IPs in a gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}/ips","href":"/api-reference/vpcs/list-egress-ips-in-a-gateway"},{"title":"Allocate a new egress IP from the gateway","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /vpcs/{vpcName}/egressgateways/{gatewayName}/ips","href":"/api-reference/vpcs/allocate-a-new-egress-ip-from-the-gateway"},{"title":"Get an egress IP by name","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /vpcs/{vpcName}/egressgateways/{gatewayName}/ips/{ipName}","href":"/api-reference/vpcs/get-an-egress-ip-by-name"},{"title":"Delete an egress IP","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /vpcs/{vpcName}/egressgateways/{gatewayName}/ips/{ipName}","href":"/api-reference/vpcs/delete-an-egress-ip"}]},{"group":"workspaces","pages":[{"title":"Get enabled features for workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /features","href":"/api-reference/workspaces/get-enabled-features-for-workspace"},{"title":"List workspace team members","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /users","href":"/api-reference/workspaces/list-workspace-team-members"},{"title":"Invite user to workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /users","href":"/api-reference/workspaces/invite-user-to-workspace"},{"title":"Update user role in workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /users/{subOrEmail}","href":"/api-reference/workspaces/update-user-role-in-workspace"},{"title":"Remove user from workspace or revoke invitation","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /users/{subOrEmail}","href":"/api-reference/workspaces/remove-user-from-workspace-or-revoke-invitation"},{"title":"List accessible workspaces","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /workspaces","href":"/api-reference/workspaces/list-accessible-workspaces"},{"title":"Create workspace tenant","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /workspaces","href":"/api-reference/workspaces/create-workspace-tenant"},{"title":"Get workspace details","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /workspaces/{workspaceName}","href":"/api-reference/workspaces/get-workspace-details"},{"title":"Update workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /workspaces/{workspaceName}","href":"/api-reference/workspaces/update-workspace"},{"title":"Delete workspace tenant","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /workspaces/{workspaceName}","href":"/api-reference/workspaces/delete-workspace-tenant"},{"title":"Leave workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /workspaces/{workspaceName}/leave","href":"/api-reference/workspaces/leave-workspace"},{"title":"Check workspace availability","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /workspaces/availability","href":"/api-reference/workspaces/check-workspace-availability"}]},{"group":"featureFlags","pages":[{"title":"Retrieve feature flag evaluation for workspace","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /features/{featureKey}","href":"/api-reference/featureflags/retrieve-feature-flag-evaluation-for-workspace"}]},{"group":"functions","pages":[{"title":"List all MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions","href":"/api-reference/functions/list-all-mcp-servers"},{"title":"Create MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /functions","href":"/api-reference/functions/create-mcp-server"},{"title":"Get MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions/{functionName}","href":"/api-reference/functions/get-mcp-server"},{"title":"Update MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /functions/{functionName}","href":"/api-reference/functions/update-mcp-server"},{"title":"Delete MCP server","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /functions/{functionName}","href":"/api-reference/functions/delete-mcp-server"},{"title":"List function revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /functions/{functionName}/revisions","href":"/api-reference/functions/list-function-revisions"}]},{"group":"images","pages":[{"title":"List container images","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images","href":"/api-reference/images/list-container-images"},{"title":"Build a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /images","href":"/api-reference/images/build-a-container-image"},{"title":"Cleanup unused container images","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images","href":"/api-reference/images/cleanup-unused-container-images"},{"title":"Get container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}","href":"/api-reference/images/get-container-image"},{"title":"Delete container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}","href":"/api-reference/images/delete-container-image"},{"title":"List image shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}/share","href":"/api-reference/images/list-image-shares"},{"title":"Share a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /images/{resourceType}/{imageName}/share","href":"/api-reference/images/share-a-container-image"},{"title":"Unshare a container image","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}/share/{targetWorkspace}","href":"/api-reference/images/unshare-a-container-image"},{"title":"List image tags","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /images/{resourceType}/{imageName}/tags","href":"/api-reference/images/list-image-tags"},{"title":"Delete container image tag","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /images/{resourceType}/{imageName}/tags/{tagName}","href":"/api-reference/images/delete-container-image-tag"},{"title":"List pending image shares","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /pending-image-shares","href":"/api-reference/images/list-pending-image-shares"},{"title":"Accept a pending image share","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /pending-image-shares/{pendingShareId}/accept","href":"/api-reference/images/accept-a-pending-image-share"},{"title":"Decline a pending image share","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /pending-image-shares/{pendingShareId}/decline","href":"/api-reference/images/decline-a-pending-image-share"}]},{"group":"integrations","pages":[{"title":"Get integration provider info","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/{integrationName}","href":"/api-reference/integrations/get-integration-provider-info"},{"title":"List integration connections","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections","href":"/api-reference/integrations/list-integration-connections"},{"title":"Create integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /integrations/connections","href":"/api-reference/integrations/create-integration-connection"},{"title":"Get integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}","href":"/api-reference/integrations/get-integration-connection"},{"title":"Update integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /integrations/connections/{connectionName}","href":"/api-reference/integrations/update-integration-connection"},{"title":"Delete integration connection","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /integrations/connections/{connectionName}","href":"/api-reference/integrations/delete-integration-connection"},{"title":"Get integration connection model endpoint configurations","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/endpointConfigurations","href":"/api-reference/integrations/get-integration-connection-model-endpoint-configurations"},{"title":"List integration connection models","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/models","href":"/api-reference/integrations/list-integration-connection-models"},{"title":"Get integration connection model","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /integrations/connections/{connectionName}/models/{modelId}","href":"/api-reference/integrations/get-integration-connection-model"}]},{"group":"jobs","pages":[{"title":"List batch jobs","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs","href":"/api-reference/jobs/list-batch-jobs"},{"title":"Create batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /jobs","href":"/api-reference/jobs/create-batch-job"},{"title":"Get batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}","href":"/api-reference/jobs/get-batch-job"},{"title":"Update batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /jobs/{jobId}","href":"/api-reference/jobs/update-batch-job"},{"title":"Delete batch job","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /jobs/{jobId}","href":"/api-reference/jobs/delete-batch-job"},{"title":"List job executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions","href":"/api-reference/jobs/list-job-executions"},{"title":"Create job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /jobs/{jobId}/executions","href":"/api-reference/jobs/create-job-execution"},{"title":"Get job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions/{executionId}","href":"/api-reference/jobs/get-job-execution"},{"title":"Cancel job execution","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /jobs/{jobId}/executions/{executionId}","href":"/api-reference/jobs/cancel-job-execution"},{"title":"List execution tasks","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/executions/{executionId}/tasks","href":"/api-reference/jobs/list-execution-tasks"},{"title":"List job revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /jobs/{jobId}/revisions","href":"/api-reference/jobs/list-job-revisions"}]},{"group":"locations","pages":[{"title":"List deployment regions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /locations","href":"/api-reference/locations/list-deployment-regions"}]},{"group":"mcphub","pages":[{"title":"List MCP Hub servers","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /mcp/hub","href":"/api-reference/mcphub/list-mcp-hub-servers"}]},{"group":"models","pages":[{"title":"List model endpoints","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models","href":"/api-reference/models/list-model-endpoints"},{"title":"Create model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /models","href":"/api-reference/models/create-model-endpoint"},{"title":"Get model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models/{modelName}","href":"/api-reference/models/get-model-endpoint"},{"title":"Update model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /models/{modelName}","href":"/api-reference/models/update-model-endpoint"},{"title":"Delete model endpoint","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /models/{modelName}","href":"/api-reference/models/delete-model-endpoint"},{"title":"List model revisions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /models/{modelName}/revisions","href":"/api-reference/models/list-model-revisions"}]},{"group":"policies","pages":[{"title":"List governance policies","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies","href":"/api-reference/policies/list-governance-policies"},{"title":"Create governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /policies","href":"/api-reference/policies/create-governance-policy"},{"title":"Get governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies/{policyName}","href":"/api-reference/policies/get-governance-policy"},{"title":"Update governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /policies/{policyName}","href":"/api-reference/policies/update-governance-policy"},{"title":"Delete governance policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /policies/{policyName}","href":"/api-reference/policies/delete-governance-policy"},{"title":"List resources using a policy","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /policies/{policyName}/usages","href":"/api-reference/policies/list-resources-using-a-policy"}]},{"group":"publicIps:list","pages":[{"title":"List public ips","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /publicIps","href":"/api-reference/publicips:list/list-public-ips"}]},{"group":"sandboxhub","pages":[{"title":"List Sandbox Hub templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandbox/hub","href":"/api-reference/sandboxhub/list-sandbox-hub-templates"}]},{"group":"compute","pages":[{"title":"List sandboxes","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes","href":"/api-reference/compute/list-sandboxes"},{"title":"Create sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes","href":"/api-reference/compute/create-sandbox"},{"title":"Get sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}","href":"/api-reference/compute/get-sandbox"},{"title":"Update sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}","href":"/api-reference/compute/update-sandbox"},{"title":"Delete sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}","href":"/api-reference/compute/delete-sandbox"},{"title":"Archive sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/archive","href":"/api-reference/compute/archive-sandbox"},{"title":"Fork sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/fork","href":"/api-reference/compute/fork-sandbox"},{"title":"List Sandbox Previews","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews","href":"/api-reference/compute/list-sandbox-previews"},{"title":"Create Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/previews","href":"/api-reference/compute/create-sandbox-preview"},{"title":"Get Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/get-sandbox-preview"},{"title":"Update Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/update-sandbox-preview"},{"title":"Delete Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/previews/{previewName}","href":"/api-reference/compute/delete-sandbox-preview"},{"title":"Get tokens for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/previews/{previewName}/tokens","href":"/api-reference/compute/get-tokens-for-sandbox-preview"},{"title":"Create token for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/previews/{previewName}/tokens","href":"/api-reference/compute/create-token-for-sandbox-preview"},{"title":"Delete token for Sandbox Preview","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/previews/{previewName}/tokens/{tokenName}","href":"/api-reference/compute/delete-token-for-sandbox-preview"},{"title":"List Sandbox Schedule Executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedule-executions","href":"/api-reference/compute/list-sandbox-schedule-executions"},{"title":"List Sandbox Schedules","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedules","href":"/api-reference/compute/list-sandbox-schedules"},{"title":"Create Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/schedules","href":"/api-reference/compute/create-sandbox-schedule"},{"title":"Get Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/get-sandbox-schedule"},{"title":"Update Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/update-sandbox-schedule"},{"title":"Delete Sandbox Schedule","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/schedules/{scheduleId}","href":"/api-reference/compute/delete-sandbox-schedule"},{"title":"List sandbox snapshots","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/{sandboxName}/snapshots","href":"/api-reference/compute/list-sandbox-snapshots"},{"title":"Create sandbox snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/snapshots","href":"/api-reference/compute/create-sandbox-snapshot"},{"title":"Delete sandbox snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /sandboxes/{sandboxName}/snapshots/{snapshotId}","href":"/api-reference/compute/delete-sandbox-snapshot"},{"title":"Restore sandbox from snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/snapshots/{snapshotId}/restore","href":"/api-reference/compute/restore-sandbox-from-snapshot"},{"title":"Unarchive sandbox","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /sandboxes/{sandboxName}/unarchive","href":"/api-reference/compute/unarchive-sandbox"},{"title":"Get sandbox by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /sandboxes/by-external-id/{externalId}","href":"/api-reference/compute/get-sandbox-by-external-id"},{"title":"List Workspace Schedule Executions","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedule-executions","href":"/api-reference/compute/list-workspace-schedule-executions"},{"title":"List Workspace Schedules","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedules","href":"/api-reference/compute/list-workspace-schedules"},{"title":"Get Sandbox Scheduling Metrics","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /schedules/metrics","href":"/api-reference/compute/get-sandbox-scheduling-metrics"},{"title":"List snapshots","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots","href":"/api-reference/compute/list-snapshots"},{"title":"Create snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /snapshots","href":"/api-reference/compute/create-snapshot"},{"title":"Get snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /snapshots/{snapshotName}","href":"/api-reference/compute/get-snapshot"},{"title":"Delete snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /snapshots/{snapshotName}","href":"/api-reference/compute/delete-snapshot"},{"title":"Fork snapshot","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /snapshots/{snapshotName}/fork","href":"/api-reference/compute/fork-snapshot"}]},{"group":"secrets","pages":[{"title":"List secrets","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /secrets","href":"/api-reference/secrets/list-secrets"},{"title":"Upsert secret","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /secrets","href":"/api-reference/secrets/upsert-secret"},{"title":"Delete secret by query","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /secrets","href":"/api-reference/secrets/delete-secret-by-query"},{"title":"Delete secret","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /secrets/{secretName}","href":"/api-reference/secrets/delete-secret"}]},{"group":"service_accounts","pages":[{"title":"List service accounts","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /service_accounts","href":"/api-reference/service_accounts/list-service-accounts"},{"title":"Create service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /service_accounts","href":"/api-reference/service_accounts/create-service-account"},{"title":"Update service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /service_accounts/{clientId}","href":"/api-reference/service_accounts/update-service-account"},{"title":"Delete service account","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /service_accounts/{clientId}","href":"/api-reference/service_accounts/delete-service-account"},{"title":"List service account API keys","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /service_accounts/{clientId}/api_keys","href":"/api-reference/service_accounts/list-service-account-api-keys"},{"title":"Create service account API key","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /service_accounts/{clientId}/api_keys","href":"/api-reference/service_accounts/create-service-account-api-key"},{"title":"Revoke service account API key","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /service_accounts/{clientId}/api_keys/{apiKeyId}","href":"/api-reference/service_accounts/revoke-service-account-api-key"}]},{"group":"templates","pages":[{"title":"List deployment templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /templates","href":"/api-reference/templates/list-deployment-templates"},{"title":"Get template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /templates/{templateName}","href":"/api-reference/templates/get-template"}]},{"group":"volumeTemplates","pages":[{"title":"List volume templates","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volume_templates","href":"/api-reference/volumetemplates/list-volume-templates"},{"title":"Create volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /volume_templates","href":"/api-reference/volumetemplates/create-volume-template"},{"title":"Get volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/get-volume-template"},{"title":"Create or update volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/create-or-update-volume-template"},{"title":"Delete volume template","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volume_templates/{volumeTemplateName}","href":"/api-reference/volumetemplates/delete-volume-template"},{"title":"Delete volume template version","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volume_templates/{volumeTemplateName}/versions/{versionName}","href":"/api-reference/volumetemplates/delete-volume-template-version"}]},{"group":"volumes","pages":[{"title":"List persistent volumes","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes","href":"/api-reference/volumes/list-persistent-volumes"},{"title":"Create persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml post /volumes","href":"/api-reference/volumes/create-persistent-volume"},{"title":"Get persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes/{volumeName}","href":"/api-reference/volumes/get-persistent-volume"},{"title":"Update volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml put /volumes/{volumeName}","href":"/api-reference/volumes/update-volume"},{"title":"Delete persistent volume","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml delete /volumes/{volumeName}","href":"/api-reference/volumes/delete-persistent-volume"},{"title":"Get volume by external ID","deprecated":null,"version":null,"openapi":"/api-reference/controlplane.yml get /volumes/by-external-id/{externalId}","href":"/api-reference/volumes/get-volume-by-external-id"}]}]}]},{"tab":"Sandbox API Reference","groups":[{"group":"archive","pages":[{"title":"Export the filesystem changes to a presigned URL","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /archive/export","href":"/api-reference/archive/export-the-filesystem-changes-to-a-presigned-url"},{"title":"Lift the archive freeze","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /archive/resume","href":"/api-reference/archive/lift-the-archive-freeze"},{"title":"Get the archive status","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /archive/status","href":"/api-reference/archive/get-the-archive-status"}]},{"group":"fastapply","pages":[{"title":"Apply code edit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /codegen/fastapply/{path}","href":"/api-reference/fastapply/apply-code-edit"}]},{"group":"codegen","pages":[{"title":"Code reranking/semantic search","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /codegen/reranking/{path}","href":"/api-reference/codegen/code-rerankingsemantic-search"}]},{"group":"drive","pages":[{"title":"List currently mounted drives","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /drives/mount","href":"/api-reference/drive/list-currently-mounted-drives"},{"title":"Attach a drive to a local path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /drives/mount","href":"/api-reference/drive/attach-a-drive-to-a-local-path"},{"title":"Detach a drive from a local path","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /drives/mount/{mountPath}","href":"/api-reference/drive/detach-a-drive-from-a-local-path"}]},{"group":"system","pages":[{"title":"Reload environment from guest metadata","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /environment/reload","href":"/api-reference/system/reload-environment-from-guest-metadata"},{"title":"Health check","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /health","href":"/api-reference/system/health-check"},{"title":"Upgrade the sandbox-api","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /upgrade","href":"/api-reference/system/upgrade-the-sandbox-api"}]},{"group":"filesystem","pages":[{"title":"Search for text content in files","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-content-search/{path}","href":"/api-reference/filesystem/search-for-text-content-in-files"},{"title":"Find files and directories","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-find/{path}","href":"/api-reference/filesystem/find-files-and-directories"},{"title":"List multipart uploads","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-multipart","href":"/api-reference/filesystem/list-multipart-uploads"},{"title":"Abort multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem-multipart/{uploadId}/abort","href":"/api-reference/filesystem/abort-multipart-upload"},{"title":"Complete multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /filesystem-multipart/{uploadId}/complete","href":"/api-reference/filesystem/complete-multipart-upload"},{"title":"Upload part","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem-multipart/{uploadId}/part","href":"/api-reference/filesystem/upload-part"},{"title":"List parts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-multipart/{uploadId}/parts","href":"/api-reference/filesystem/list-parts"},{"title":"Initiate multipart upload","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /filesystem-multipart/initiate/{path}","href":"/api-reference/filesystem/initiate-multipart-upload"},{"title":"Fuzzy search for files and directories","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem-search/{path}","href":"/api-reference/filesystem/fuzzy-search-for-files-and-directories"},{"title":"Get file or directory information","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem/{path}","href":"/api-reference/filesystem/get-file-or-directory-information"},{"title":"Create or update a file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem/{path}","href":"/api-reference/filesystem/create-or-update-a-file-or-directory"},{"title":"Delete file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem/{path}","href":"/api-reference/filesystem/delete-file-or-directory"},{"title":"Stat a file or directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml head /filesystem/{path}","href":"/api-reference/filesystem/stat-a-file-or-directory"},{"title":"Get directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /filesystem/tree/{path}","href":"/api-reference/filesystem/get-directory-tree"},{"title":"Create or update directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /filesystem/tree/{path}","href":"/api-reference/filesystem/create-or-update-directory-tree"},{"title":"Delete directory tree","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /filesystem/tree/{path}","href":"/api-reference/filesystem/delete-directory-tree"},{"title":"Stream file modification events in a directory","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /watch/filesystem/{path}","href":"/api-reference/filesystem/stream-file-modification-events-in-a-directory"}]},{"group":"network","pages":[{"title":"Start monitoring ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /network/process/{pid}/monitor","href":"/api-reference/network/start-monitoring-ports-for-a-process"},{"title":"Stop monitoring ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /network/process/{pid}/monitor","href":"/api-reference/network/stop-monitoring-ports-for-a-process"},{"title":"Get open ports for a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /network/process/{pid}/ports","href":"/api-reference/network/get-open-ports-for-a-process"},{"title":"Disconnect tunnel","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /network/tunnel","href":"/api-reference/network/disconnect-tunnel"},{"title":"Update tunnel configuration","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml put /network/tunnel/config","href":"/api-reference/network/update-tunnel-configuration"}]},{"group":"process","pages":[{"title":"List all processes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process","href":"/api-reference/process/list-all-processes"},{"title":"Execute a command","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /process","href":"/api-reference/process/execute-a-command"},{"title":"Get process by identifier","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}","href":"/api-reference/process/get-process-by-identifier"},{"title":"Stop a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}","href":"/api-reference/process/stop-a-process"},{"title":"Kill a process","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}/kill","href":"/api-reference/process/kill-a-process"},{"title":"Get process logs","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}/logs","href":"/api-reference/process/get-process-logs"},{"title":"Stream process logs in real time","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml get /process/{identifier}/logs/stream","href":"/api-reference/process/stream-process-logs-in-real-time"},{"title":"Write to a process's stdin","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /process/{identifier}/stdin","href":"/api-reference/process/write-to-a-processs-stdin"},{"title":"Close a process's stdin","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml delete /process/{identifier}/stdin","href":"/api-reference/process/close-a-processs-stdin"}]}]},{"tab":"SDK Reference","groups":[{"group":"Get started","pages":[{"title":"Blaxel SDKs overview","sidebarTitle":"Overview","href":"/sdk-reference/introduction"},{"title":"TypeScript SDK","href":"/sdk-reference/sdk-ts"},{"title":"Python SDK","href":"/sdk-reference/sdk-python"},{"title":"Go SDK","href":"/sdk-reference/sdk-go"}]}]},{"tab":"CLI Reference","groups":[{"group":"Overview","pages":[{"title":"Blaxel CLI overview","sidebarTitle":"Overview","href":"/cli-reference/introduction"},{"group":"Commands","pages":[{"title":"bl apply","href":"/cli-reference/commands/bl_apply"},{"title":"bl chat","href":"/cli-reference/commands/bl_chat"},{"title":"bl completion","href":"/cli-reference/commands/bl_completion"},{"title":"bl connect","href":"/cli-reference/commands/bl_connect"},{"title":"bl connect sandbox","href":"/cli-reference/commands/bl_connect_sandbox"},{"title":"bl delete","href":"/cli-reference/commands/bl_delete"},{"title":"bl delete agent","href":"/cli-reference/commands/bl_delete_agent"},{"title":"bl delete application","href":"/cli-reference/commands/bl_delete_application"},{"title":"bl delete drive","href":"/cli-reference/commands/bl_delete_drive"},{"title":"bl delete function","href":"/cli-reference/commands/bl_delete_function"},{"title":"bl delete image","href":"/cli-reference/commands/bl_delete_image"},{"title":"bl delete integrationconnection","href":"/cli-reference/commands/bl_delete_integrationconnection"},{"title":"bl delete job","href":"/cli-reference/commands/bl_delete_job"},{"title":"bl delete model","href":"/cli-reference/commands/bl_delete_model"},{"title":"bl delete policy","href":"/cli-reference/commands/bl_delete_policy"},{"title":"bl delete preview","href":"/cli-reference/commands/bl_delete_preview"},{"title":"bl delete previewtoken","href":"/cli-reference/commands/bl_delete_previewtoken"},{"title":"bl delete sandbox","href":"/cli-reference/commands/bl_delete_sandbox"},{"title":"bl delete snapshot","href":"/cli-reference/commands/bl_delete_snapshot"},{"title":"bl delete volume","href":"/cli-reference/commands/bl_delete_volume"},{"title":"bl delete volumetemplate","href":"/cli-reference/commands/bl_delete_volumetemplate"},{"title":"bl deploy","href":"/cli-reference/commands/bl_deploy"},{"title":"bl drive","href":"/cli-reference/commands/bl_drive"},{"title":"bl drive create","href":"/cli-reference/commands/bl_drive_create"},{"title":"bl drive delete","href":"/cli-reference/commands/bl_drive_delete"},{"title":"bl drive get","href":"/cli-reference/commands/bl_drive_get"},{"title":"bl drive list","href":"/cli-reference/commands/bl_drive_list"},{"title":"bl drive mount","href":"/cli-reference/commands/bl_drive_mount"},{"title":"bl drive mounts","href":"/cli-reference/commands/bl_drive_mounts"},{"title":"bl drive unmount","href":"/cli-reference/commands/bl_drive_unmount"},{"title":"bl fork","href":"/cli-reference/commands/bl_fork"},{"title":"bl get","href":"/cli-reference/commands/bl_get"},{"title":"bl get agents","href":"/cli-reference/commands/bl_get_agents"},{"title":"bl get applications","href":"/cli-reference/commands/bl_get_applications"},{"title":"bl get drives","href":"/cli-reference/commands/bl_get_drives"},{"title":"bl get functions","href":"/cli-reference/commands/bl_get_functions"},{"title":"bl get image","href":"/cli-reference/commands/bl_get_image"},{"title":"bl get integrationconnections","href":"/cli-reference/commands/bl_get_integrationconnections"},{"title":"bl get jobs","href":"/cli-reference/commands/bl_get_jobs"},{"title":"bl get mcp-hub","href":"/cli-reference/commands/bl_get_mcp-hub"},{"title":"bl get models","href":"/cli-reference/commands/bl_get_models"},{"title":"bl get policies","href":"/cli-reference/commands/bl_get_policies"},{"title":"bl get previews","href":"/cli-reference/commands/bl_get_previews"},{"title":"bl get previewtokens","href":"/cli-reference/commands/bl_get_previewtokens"},{"title":"bl get sandbox-hub","href":"/cli-reference/commands/bl_get_sandbox-hub"},{"title":"bl get sandboxes","href":"/cli-reference/commands/bl_get_sandboxes"},{"title":"bl get snapshots","href":"/cli-reference/commands/bl_get_snapshots"},{"title":"bl get templates","href":"/cli-reference/commands/bl_get_templates"},{"title":"bl get volumes","href":"/cli-reference/commands/bl_get_volumes"},{"title":"bl get volumetemplates","href":"/cli-reference/commands/bl_get_volumetemplates"},{"title":"bl login","href":"/cli-reference/commands/bl_login"},{"title":"bl logout","href":"/cli-reference/commands/bl_logout"},{"title":"bl logs","href":"/cli-reference/commands/bl_logs"},{"title":"bl mcp","href":"/cli-reference/commands/bl_mcp"},{"title":"bl new","href":"/cli-reference/commands/bl_new"},{"title":"bl push","href":"/cli-reference/commands/bl_push"},{"title":"bl run","href":"/cli-reference/commands/bl_run"},{"title":"bl serve","href":"/cli-reference/commands/bl_serve"},{"title":"bl setup","href":"/cli-reference/commands/bl_setup"},{"title":"bl share","href":"/cli-reference/commands/bl_share"},{"title":"bl share image","href":"/cli-reference/commands/bl_share_image"},{"title":"bl skills","href":"/cli-reference/commands/bl_skills"},{"title":"bl skills autoupdate","href":"/cli-reference/commands/bl_skills_autoupdate"},{"title":"bl skills install","href":"/cli-reference/commands/bl_skills_install"},{"title":"bl skills status","href":"/cli-reference/commands/bl_skills_status"},{"title":"bl skills update","href":"/cli-reference/commands/bl_skills_update"},{"title":"bl token","href":"/cli-reference/commands/bl_token"},{"title":"bl unshare","href":"/cli-reference/commands/bl_unshare"},{"title":"bl unshare image","href":"/cli-reference/commands/bl_unshare_image"},{"title":"bl upgrade","href":"/cli-reference/commands/bl_upgrade"},{"title":"bl version","href":"/cli-reference/commands/bl_version"},{"title":"bl workspaces","href":"/cli-reference/commands/bl_workspaces"}]}]}]},{"tab":"Deployment Reference","groups":[{"group":"Overview","pages":[{"title":"blaxel.toml deployment configuration file reference","href":"/deployment-reference"}]}]}]},"basePath":"","title":"API reference index - Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["10e4515597"],"chunks":["BannerMarkdown-CXEEkV6J.js","dist-lvhuD9Du.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-D1Z-ELXV.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js"]}