Your account-level Brimble API key. Find it in the dashboard under
your profile drawer → API key (click the avatar in the sidebar).
Available on paid plans only.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Brimble","description":"Brimble documentation. Deploy applications, manage domains, scale services, and ship without operating infrastructure.","colors":{"primary":"#006fff","light":"#006fff","dark":"#006fff"},"logo":{"light":"https://mintcdn.com/brimble-86/SR8fPQyZ_KbNTiea/logo/icon.png?fit=max\u0026auto=format\u0026n=SR8fPQyZ_KbNTiea\u0026q=85\u0026s=f4a01ce77637fe22d051f2c4fdb128e8","dark":"https://mintcdn.com/brimble-86/SR8fPQyZ_KbNTiea/logo/icon.png?fit=max\u0026auto=format\u0026n=SR8fPQyZ_KbNTiea\u0026q=85\u0026s=f4a01ce77637fe22d051f2c4fdb128e8"},"favicon":"https://mintcdn.com/brimble-86/SR8fPQyZ_KbNTiea/logo/icon.png?fit=max\u0026auto=format\u0026n=SR8fPQyZ_KbNTiea\u0026q=85\u0026s=f4a01ce77637fe22d051f2c4fdb128e8","background":{"color":{"light":"#ffffff","dark":"#1a1c1e"}},"navbar":{"links":[{"href":"https://app.brimble.io","label":"Dashboard"},{"href":"https://brimble.io/changelog","label":"Changelog"},{"href":"https://status.brimble.io","label":"Status"}],"primary":{"type":"button","label":"Sign up","href":"https://app.brimble.io/signup"}},"footer":{"socials":{"x":"https://x.com/brimblehq","github":"https://github.com/brimblehq"}},"seo":{"metatags":{"og:type":"website","og:site_name":"Brimble Docs","og:image":"https://brimble.io/og-image.png","twitter:card":"summary_large_image","twitter:site":"@brimblehq","twitter:creator":"@brimblehq","robots":"index, follow"},"indexing":"all"},"fonts":{"heading":{"family":"ABC Marfa","weight":700,"source":"fonts/ABCMarfaVariableVF-Trial.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"brimble-86","hasAudioNarration":false,"actualSubdomain":"brimble-86","customDomains":["paper.brimble.io"],"gitSource":{"type":"github","owner":"brimblehq","repo":"paper","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae342dbf2e535e50ffb1572","collectionId":"217f9fd9-3ec8-4e03-8d1e-81b42d132526","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae342dbf2e535e50ffb1572"},"feedback":{"thumbs":true,"issues":false,"agentFeedback":true,"edits":false},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae59e6167c58c3a14fda205","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Core API","count":116},{"language":"default","tag":"Documentation","count":102},{"language":"default","tag":"Projects","count":36},{"language":"default","tag":"Sandboxes","count":29},{"language":"default","tag":"Sandbox API","count":23},{"language":"default","tag":"Domains","count":22},{"language":"default","tag":"Environments","count":14},{"language":"default","tag":"Databases","count":12},{"language":"default","tag":"CLI","count":10},{"language":"default","tag":"Object Storage","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"b,em strong,strong,strong em{font-family:\"ABC Marfa\",-apple-system,BlinkMacSystemFont,\"Segoe UI\",system-ui,sans-serif;font-weight:700}:root.dark,[data-theme=dark],html.dark{--bg-page-dark:#1a1c1e;--bg-elevated-dark:#202022;--bg-elevated-2-dark:#29292a;--bg-surface-dark:#222528;--text-strong-dark:#ffffff;--text-body-dark:#bdbcbc;--text-faded-dark:#9a9d9c;--text-extra-faded-dark:#8e9195;--border-dark:#454545}.dark body,[data-theme=dark] body{background-color:#1a1c1e;color:#bdbcbc}.dark h1,.dark h2,.dark h3,.dark h4,.dark td strong,[data-theme=dark] h1,[data-theme=dark] h2,[data-theme=dark] h3,[data-theme=dark] h4,[data-theme=dark] td strong{color:#fff}.dark .card,.dark [class*=Check],.dark [class*=Frame],.dark [class*=Info],.dark [class*=Note],.dark [class*=Tip],.dark [class*=Warning],.dark [class*=callout],.dark blockquote,[data-theme=dark] .card,[data-theme=dark] [class*=Frame],[data-theme=dark] [class*=callout],[data-theme=dark] blockquote{background-color:#202022;border-color:#454545}.dark code:not(pre code),[data-theme=dark] code:not(pre code){background-color:#29292a;color:#fff;border:.5px solid #454545}.dark .code-block,.dark hr,[data-theme=dark] .code-block,[data-theme=dark] hr{border-color:#454545}.dark pre,.dark pre code,[data-theme=dark] .code-block [data-component-part=code-block-root],[data-theme=dark] pre,[data-theme=dark] pre code,html.dark .code-block [data-component-part=code-block-root],html.dark .code-block pre code,html.dark .code-block pre.shiki{background-color:#202022!important;border:0;box-shadow:none}.dark .code-block-fade-overlay,[data-theme=dark] .code-block-fade-overlay{--fade-color-dark:#202022!important}.dark table,[data-theme=dark] table{border-collapse:separate;border-spacing:0;background-color:#202022;border:1px solid rgba(255,255,255,.08);border-radius:10px;overflow:hidden}.dark thead,[data-theme=dark] thead{background-color:#29292a}.dark th,[data-theme=dark] th{padding:10px 16px;color:#fff;font-size:.8125rem;font-weight:600;border:0;border-bottom:1px solid rgba(255,255,255,.08)}.dark td,[data-theme=dark] td{padding:12px 16px;color:#bdbcbc;vertical-align:top;border:0;border-top:1px solid rgba(255,255,255,.06)}.dark tbody tr:first-child td,[data-theme=dark] tbody tr:first-child td{border-top:0}.dark tbody tr,[data-theme=dark] tbody tr{background-color:transparent;transition:background-color 120ms ease}.dark tbody tr:hover,[data-theme=dark] tbody tr:hover{background-color:rgba(255,255,255,.025)}.dark table:not(:has(th:not(:empty))) thead,[data-theme=dark] table:not(:has(th:not(:empty))) thead{display:none}.dark table:not(:has(th:not(:empty))) td:first-child,[data-theme=dark] table:not(:has(th:not(:empty))) td:first-child{width:30%;color:#fff}.dark aside,.dark nav,[data-theme=dark] aside,[data-theme=dark] nav{background-color:#1a1c1e;border-color:#454545}.dark aside a.active,.dark aside a[aria-current=page],[data-theme=dark] aside a.active,[data-theme=dark] aside a[aria-current=page]{background-color:#29292a;color:#fff}.dark ::selection,[data-theme=dark] ::selection{background:rgba(255,155,0,.45);color:#fff6e8}*{scrollbar-width:thin;scrollbar-color:rgba(0,0,0,.18) transparent}.dark *,[data-theme=dark] *{scrollbar-color:rgba(255,255,255,.14) transparent}::-webkit-scrollbar{width:8px;height:8px}::-webkit-scrollbar-track{background:0 0}::-webkit-scrollbar-thumb{background-color:rgba(0,0,0,.18);border-radius:999px;border:2px solid transparent;background-clip:padding-box}::-webkit-scrollbar-thumb:hover{background-color:rgba(0,0,0,.28)}.dark ::-webkit-scrollbar-thumb,[data-theme=dark] ::-webkit-scrollbar-thumb{background-color:rgba(255,255,255,.14)}.dark ::-webkit-scrollbar-thumb:hover,[data-theme=dark] ::-webkit-scrollbar-thumb:hover{background-color:rgba(255,255,255,.22)}[id*=toc i] ol,[id*=toc i] ul,aside[aria-label*=\"on this page\"i] ol,aside[aria-label*=\"on this page\"i] ul,nav[aria-labelledby*=on-this-page i] ol,nav[aria-labelledby*=on-this-page i] ul{position:relative;padding-left:16px;margin-left:0;list-style:none}[id*=toc i]>ol::before,[id*=toc i]>ul::before,aside[aria-label*=\"on this page\"i]>ol::before,aside[aria-label*=\"on this page\"i]>ul::before,nav[aria-labelledby*=on-this-page i]>ol::before,nav[aria-labelledby*=on-this-page i]>ul::before{content:\"\";position:absolute;left:5px;top:0;bottom:0;width:1.5px;background-color:rgba(0,0,0,.1);border-radius:999px}.dark [id*=toc i]>ol::before,.dark [id*=toc i]>ul::before,.dark aside[aria-label*=\"on this page\"i]>ol::before,.dark aside[aria-label*=\"on this page\"i]>ul::before,.dark nav[aria-labelledby*=on-this-page i]>ol::before,.dark nav[aria-labelledby*=on-this-page i]>ul::before,[data-theme=dark] [id*=toc i]>ul::before,[data-theme=dark] nav[aria-labelledby*=on-this-page i]>ol::before{background-color:rgba(255,255,255,.1)}[id*=toc i] li,aside[aria-label*=\"on this page\"i] li,nav[aria-labelledby*=on-this-page i] li{position:relative}[id*=toc i] li:has(>a.active)::before,[id*=toc i] li:has(>a[aria-current=page])::before,[id*=toc i] li:has(>a[aria-current=true])::before,aside[aria-label*=\"on this page\"i] li:has(>a.active)::before,aside[aria-label*=\"on this page\"i] li:has(>a[aria-current=page])::before,aside[aria-label*=\"on this page\"i] li:has(>a[aria-current=true])::before,nav[aria-labelledby*=on-this-page i] li:has(>a.active)::before,nav[aria-labelledby*=on-this-page i] li:has(>a[aria-current=page])::before,nav[aria-labelledby*=on-this-page i] li:has(>a[aria-current=true])::before,nav[aria-labelledby*=on-this-page i] li:has(>a[data-active=true])::before{content:\"\";position:absolute;left:1px;top:50%;width:9px;height:9px;border-radius:999px;background-color:#006fff;box-shadow:0 0 0 3px rgba(0,111,255,.18);transform:translateY(-50%);z-index:1}"}],"page":{"pagePath":"api-reference/sandboxes/code","slug":"/api-reference/sandboxes/code","pageMetadata":{"title":"Run a code snippet","description":"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/code","og:image":"https://paper.brimble.io/og/api-reference/sandboxes/code.png ","twitter:image":"https://paper.brimble.io/og/api-reference/sandboxes/code.png ","href":"/api-reference/sandboxes/code"},"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: \"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Run a code snippet","description":"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/code","og:image":"https://paper.brimble.io/og/api-reference/sandboxes/code.png ","twitter:image":"https://paper.brimble.io/og/api-reference/sandboxes/code.png ","href":"/api-reference/sandboxes/code"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Runtime"],"summary":"Run a code snippet","description":"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.","operationId":"runCode","parameters":["9c4b220e-f861-41d4-8da8-c2d5391556eb"],"requestBody":"a9954d9f-0b56-4c06-abae-c6be6b6b17f9","responses":{"200":"a67410ae-2409-4838-b64f-53a62deec43e","400":"d0237778-0129-4fe6-987a-3ce8a2b0ed21","404":"334544db-26e3-462e-b342-641b36fe97bb"},"method":"post","type":"path","servers":["7fd78ff4-d3d3-4eba-ac4b-b336219cee0a"],"security":["1c336691-b287-4c72-b7d1-1e464a337a72"],"path":"/sandboxes/{id}/code","baseUrlOptions":["https://sandbox.brimble.io"],"title":"Run a code snippet","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9c4b220e-f861-41d4-8da8-c2d5391556eb":{"in":"path","name":"id","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{24}$","isRequired":true,"description":"24-char hex id of the sandbox.","uniqueKey":"","typeLabel":"string"},"description":"24-char hex id of the sandbox."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["language","code"],"properties":{"language":{"type":"string","enum":["python","node"],"isRequired":true,"uniqueKey":"language","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Snippet source. Multi-line via `\\n` in the JSON string.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"timeout_seconds":{"type":"integer","minimum":1,"maximum":300,"uniqueKey":"timeout_seconds","typeLabel":"integer"},"cwd":{"type":"string","uniqueKey":"cwd","typeLabel":"string"},"env":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"env.additionalProperties","typeLabel":"string"},"description":"Extra environment variables for this snippet only. Same semantics as\n`env` on `/exec`, per-call override on top of the sandbox's default\nenvironment.\n","example":{"OPENAI_API_KEY":"sk-..."},"uniqueKey":"env","typeLabel":"object"},"stream":{"type":"boolean","description":"When true, the response is SSE (`text/event-stream`) as the snippet\nruns, same behaviour as `/exec` with `stream: true`.\n","uniqueKey":"stream","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","timeout_seconds":150,"cwd":"\u003cstring>","env":{"OPENAI_API_KEY":"sk-..."},"stream":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"a67410ae-2409-4838-b64f-53a62deec43e":{"description":"Code completed.\n\nWhen the request body has `stream: true`, the response is\n`text/event-stream`, one `ExecStreamFrame` per `data:` event.\n","content":{"application/json":{"schema":{"type":"object","required":["message","data"],"properties":{"message":{"type":"string","example":"Exec completed","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","required":["stdout","stderr","exit_code","duration_ms"],"properties":{"stdout":{"type":"string","isRequired":true,"uniqueKey":"data.stdout","typeLabel":"string"},"stderr":{"type":"string","isRequired":true,"uniqueKey":"data.stderr","typeLabel":"string"},"exit_code":{"type":"integer","isRequired":true,"uniqueKey":"data.exit_code","typeLabel":"integer"},"duration_ms":{"type":"integer","isRequired":true,"uniqueKey":"data.duration_ms","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Exec completed","data":{"stdout":"\u003cstring>","stderr":"\u003cstring>","exit_code":123,"duration_ms":123}}}},"exampleType":"generated"},"text/event-stream":{"schema":{"type":"string","description":"SSE stream of `ExecStreamFrame` JSON objects.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"d0237778-0129-4fe6-987a-3ce8a2b0ed21":{"description":"Validation error / invalid state transition","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable, user-facing error reason.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalidId":{"title":"invalidId","value":{"message":"Invalid sandbox id"}},"statusTransition":{"title":"statusTransition","value":{"message":"Sandbox is paused; only ready sandboxes can be paused"}},"fileNotDir":{"title":"fileNotDir","value":{"message":"Destination directory does not exist: /work"}},"duplicateVolumeName":{"title":"duplicateVolumeName","value":{"message":"A volume named \"node-cache\" already exists"}},"volumeAttached":{"title":"volumeAttached","value":{"message":"Volume is attached; detach it before deleting"}}},"exampleType":"examples"}},"exampleType":"examples"},"334544db-26e3-462e-b342-641b36fe97bb":{"description":"Sandbox or related resource not found (also returned when owned by another user)","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable, user-facing error reason.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"sandboxNotFound":{"title":"sandboxNotFound","value":{"message":"Sandbox not found"}},"snapshotNotFound":{"title":"snapshotNotFound","value":{"message":"Snapshot not found"}},"volumeNotFound":{"title":"volumeNotFound","value":{"message":"Volume not found"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1c336691-b287-4c72-b7d1-1e464a337a72":{"brimbleKey":{"type":"apiKey","in":"header","name":"x-brimble-key","description":"Your account-level Brimble API key. Find it in the dashboard under\nyour profile drawer → **API key** (click the avatar in the sidebar).\nAvailable on paid plans only.\n","scopes":[],"schemeName":"brimbleKey"}}},"servers":{"7fd78ff4-d3d3-4eba-ac4b-b336219cee0a":{"url":"https://sandbox.brimble.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-brimble-key","description":"Your account-level Brimble API key. Find it in the dashboard under\nyour profile drawer → **API key** (click the avatar in the sidebar).\nAvailable on paid plans only.\n","scopes":[],"schemeName":"brimbleKey"},"schema":{"title":"x-brimble-key","type":"string","description":"Your account-level Brimble API key. Find it in the dashboard under\nyour profile drawer → **API key** (click the avatar in the sidebar).\nAvailable on paid plans only.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"brimbleKey","name":"x-brimble-key"}],"title":"brimbleKey"}]},"originalFileLocation":"api-reference/sandboxes.openapi.yaml"},"subdomain":"brimble-86","siteName":"Brimble","title":"Run a code snippet - Brimble","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T08:40:55.763Z","gitLastModified":"2026-10-31T07:52:44.000Z","originalFileLocation":"api-reference/sandboxes/code.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=\"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Brimble\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_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/brimble-86/LFcyxdNu5eilxs2I/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run a code snippet - Brimble\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Brimble Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://paper.brimble.io/api-reference/sandboxes/code\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paper.brimble.io/og/api-reference/sandboxes/code.png \">\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=\"Run a code snippet - Brimble\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paper.brimble.io/og/api-reference/sandboxes/code.png \">\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/brimble-86/LFcyxdNu5eilxs2I/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Brimble\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006fff\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@brimblehq\">\u003clink data-mint-head rel=\"canonical\" href=\"https://paper.brimble.io/api-reference/sandboxes/code\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandboxes/code.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://paper.brimble.io/#organization\",\"name\":\"Brimble\",\"url\":\"https://paper.brimble.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/brimble-86/SR8fPQyZ_KbNTiea/logo/icon.png?fit=max\u0026auto=format\u0026n=SR8fPQyZ_KbNTiea\u0026q=85\u0026s=f4a01ce77637fe22d051f2c4fdb128e8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://paper.brimble.io#website\",\"name\":\"Brimble\",\"url\":\"https://paper.brimble.io\",\"publisher\":{\"@id\":\"https://paper.brimble.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://paper.brimble.io/api-reference/sandboxes/code#webpage\",\"url\":\"https://paper.brimble.io/api-reference/sandboxes/code\",\"name\":\"Run a code snippet\",\"description\":\"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\",\"dateModified\":\"2026-10-31T07:52:44.000Z\",\"isPartOf\":{\"@id\":\"https://paper.brimble.io#website\"},\"breadcrumb\":{\"@id\":\"https://paper.brimble.io/api-reference/sandboxes/code#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://paper.brimble.io/api-reference/sandboxes/code#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Runtime\",\"item\":\"https://paper.brimble.io/api-reference/sandboxes/exec\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run a code snippet\",\"item\":\"https://paper.brimble.io/api-reference/sandboxes/code\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://paper.brimble.io/api-reference/sandboxes/code#apireference\",\"headline\":\"Run a code snippet\",\"name\":\"Run a code snippet\",\"description\":\"Run a code snippet inside a sandbox and get its output with the Brimble Sandboxes API.\",\"url\":\"https://paper.brimble.io/api-reference/sandboxes/code\",\"mainEntityOfPage\":{\"@id\":\"https://paper.brimble.io/api-reference/sandboxes/code#webpage\"},\"image\":\"https://paper.brimble.io/og/api-reference/sandboxes/code.png\",\"dateModified\":\"2026-10-31T07:52:44.000Z\",\"publisher\":{\"@id\":\"https://paper.brimble.io/#organization\"},\"isPartOf\":{\"@id\":\"https://paper.brimble.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Brimble\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Brimble","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Core API","pages":[{"title":"Core API","href":"/api-reference/core/introduction"}]},{"tab":"Sandbox API","groups":[{"group":"Discovery","public":true,"icon":"compass","pages":[{"title":"List available sandbox templates","openapi":"api-reference/sandboxes.openapi.yaml GET /sandbox/templates","href":"/api-reference/sandboxes/templates-list"},{"title":"List sandbox-enabled regions","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/regions","href":"/api-reference/sandboxes/regions-list"}]},{"group":"Sandboxes","public":true,"icon":"box","pages":[{"title":"Create a sandbox","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes","href":"/api-reference/sandboxes/create"},{"title":"List sandboxes","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes","href":"/api-reference/sandboxes/list"},{"title":"Get a sandbox","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/{id}","href":"/api-reference/sandboxes/get"},{"title":"Destroy a sandbox","openapi":"api-reference/sandboxes.openapi.yaml DELETE /sandboxes/{id}","href":"/api-reference/sandboxes/destroy"},{"title":"Pause a sandbox","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/pause","href":"/api-reference/sandboxes/pause"},{"title":"Resume a paused sandbox","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/resume","href":"/api-reference/sandboxes/resume"},{"title":"Update sandbox egress","openapi":"api-reference/sandboxes.openapi.yaml PUT /sandboxes/{id}/egress","href":"/api-reference/sandboxes/egress-update"},{"title":"Get preview URL","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/{id}/ports/{port}/preview-url","href":"/api-reference/sandboxes/preview-url"}]},{"group":"Runtime","public":true,"icon":"terminal","pages":[{"title":"Run a shell command","description":"Run a shell command inside a sandbox and read its output with the Brimble Sandboxes API.","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/exec","href":"/api-reference/sandboxes/exec"},{"title":"Run a code snippet","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/code","href":"/api-reference/sandboxes/code"},{"title":"Upload a file","description":"Upload a file into a sandbox's filesystem with the Brimble Sandboxes API.","openapi":"api-reference/sandboxes.openapi.yaml PUT /sandboxes/{id}/files/{filePath}","href":"/api-reference/sandboxes/upload-file"},{"title":"Download a file","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/{id}/files/{filePath}","href":"/api-reference/sandboxes/download-file"}]},{"group":"Observability","public":true,"icon":"gauge","pages":[{"title":"Get sandbox stats","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/{id}/stats","href":"/api-reference/sandboxes/stats"}]},{"group":"Snapshots","public":true,"icon":"camera","pages":[{"title":"Create a snapshot","openapi":"api-reference/sandboxes.openapi.yaml POST /sandboxes/{id}/snapshots","href":"/api-reference/sandboxes/snapshot-create"},{"title":"List snapshots for a sandbox","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/{id}/snapshots","href":"/api-reference/sandboxes/snapshot-list"},{"title":"List all snapshots","openapi":"api-reference/sandboxes.openapi.yaml GET /sandboxes/snapshots","href":"/api-reference/sandboxes/snapshots-list-all"},{"title":"Delete a snapshot","openapi":"api-reference/sandboxes.openapi.yaml DELETE /sandboxes/snapshots/{snapshotId}","href":"/api-reference/sandboxes/snapshot-delete"}]},{"group":"Volumes","public":true,"icon":"hard-drive","pages":[{"title":"Create a volume","openapi":"api-reference/sandboxes.openapi.yaml POST /volumes","href":"/api-reference/volumes/create"},{"title":"List volumes","openapi":"api-reference/sandboxes.openapi.yaml GET /volumes","href":"/api-reference/volumes/list"},{"title":"Get a volume","openapi":"api-reference/sandboxes.openapi.yaml GET /volumes/{volumeId}","href":"/api-reference/volumes/get"},{"title":"Delete a volume","openapi":"api-reference/sandboxes.openapi.yaml DELETE /volumes/{volumeId}","href":"/api-reference/volumes/delete"}]}]}]},"basePath":"","title":"Run a code snippet - Brimble","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}