Run a command. With wait: true it answers with the output once the command ends (up to about 60 s; after
that it answers 202 with the running job). A paused machine is resumed first (resumed: true).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Voyager","description":"Set up Voyager, make your first video, connect it to your AI, and build with the Voyager API.","colors":{"primary":"#4F57D6","light":"#A3A9FF","dark":"#4F57D6"},"logo":{"light":"https://mintcdn.com/voyager/dzNfJ3ErXafJEG4z/images/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=dzNfJ3ErXafJEG4z\u0026q=85\u0026s=78ad7bf5f39a5663c58672e277398d3a","dark":"https://mintcdn.com/voyager/dzNfJ3ErXafJEG4z/images/brand/logo-dark.svg?fit=max\u0026auto=format\u0026n=dzNfJ3ErXafJEG4z\u0026q=85\u0026s=82b074dbf26fe311faf758f40d278ff6"},"favicon":"https://mintcdn.com/voyager/dzNfJ3ErXafJEG4z/images/brand/icon.png?fit=max\u0026auto=format\u0026n=dzNfJ3ErXafJEG4z\u0026q=85\u0026s=1bb28feb903e8127bbe59a847e12ab18","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#0D0050"}},"navbar":{"links":[{"href":"https://voyager.so/blog","label":"Blog"},{"href":"https://voyager.so/pricing","label":"Pricing"},{"href":"https://voyager.so","label":"voyager.so"}],"primary":{"type":"button","label":"Download Voyager","href":"https://voyager.so"}},"search":{"prompt":"Search Voyager docs..."},"seo":{"indexing":"navigable"},"fonts":{"heading":{"family":"Subito","weight":900,"source":"fonts/Subito-Black.woff","format":"woff"},"body":{"family":"Subito","weight":400,"source":"fonts/Subito-Regular.woff","format":"woff"}},"icons":{"library":"tabler"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Pricing","icon":"receipt","href":"https://voyager.so/pricing"},{"anchor":"Release notes","icon":"list","href":"https://github.com/usevoyager/voyager-releases/releases"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"voyager","hasAudioNarration":false,"actualSubdomain":"voyager","customDomains":["docs.voyager.so"],"gitSource":{"type":"github","owner":"moda-design","repo":"video-editor","deployBranch":"main","contentDirectory":".mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aee899537dd9c9d297ef332","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API","count":62},{"language":"default","tag":"API reference","count":43},{"language":"default","tag":"Get started","count":24},{"language":"default","tag":"Guides","count":19},{"language":"default","tag":"machines","count":18},{"language":"default","tag":"Connect your AI","count":9},{"language":"default","tag":"Working in Voyager","count":9},{"language":"default","tag":"Set up","count":9},{"language":"default","tag":"Account \u0026 billing","count":8},{"language":"default","tag":"Reference","count":8}]},"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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Subito\";src:url(\"/fonts/Subito-Bold.woff\") format(\"woff\");font-weight:500 800;font-style:normal;font-display:swap}@font-face{font-family:\"Space Mono\";src:url(\"/fonts/SpaceMono-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Space Mono\";src:url(\"/fonts/SpaceMono-Bold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}:root{--gray-50: 248 247 252;--gray-100: 244 242 251;--gray-200: 226 224 234;--gray-300: 202 199 216;--gray-400: 172 168 195;--gray-500: 122 115 159;--gray-600: 90 82 136;--gray-700: 61 51 115;--gray-800: 42 31 101;--gray-900: 13 0 80;--gray-950: 9 0 56;--voyager-deep: #0d0050;--voyager-ink: #0d0050;--voyager-ink-muted: rgba(13, 0, 80, 0.72);--voyager-line: rgba(13, 0, 80, 0.14);--voyager-line-strong: rgba(13, 0, 80, 0.3);--voyager-raised: #f4f2fb;--voyager-card: #f8f7fc;--voyager-mono: \"Space Mono\", ui-monospace, SFMono-Regular, Menlo, monospace}html.dark{--voyager-ink: #ffffff;--voyager-ink-muted: rgba(255, 255, 255, 0.72);--voyager-line: rgba(255, 255, 255, 0.16);--voyager-line-strong: rgba(255, 255, 255, 0.32);--voyager-raised: #170a6b;--voyager-card: rgba(255, 255, 255, 0.04)}::selection{background:rgba(79, 87, 214, 0.24)}#navbar #navbar-transition,#navbar{background-color:var(--voyager-deep)}#navbar #navbar-transition{border-color:rgba(255, 255, 255, 0.16)}#navbar{color:#ffffff}#navbar img.nav-logo.dark\\:hidden{display:none}#navbar img.nav-logo.dark\\:block{display:block}#navbar ul li:not(#topbar-cta-button)>a,#navbar .nav-tabs-item{font-family:var(--voyager-mono);font-size:0.75rem;font-weight:400;text-transform:uppercase;letter-spacing:0.16em;text-shadow:none;color:rgba(255, 255, 255, 0.72)}#navbar ul li:not(#topbar-cta-button)>a:hover,#navbar .nav-tabs-item:hover,#navbar .nav-tabs-item[data-active=\"true\"]{color:#ffffff}#navbar .nav-tabs-item>.absolute{background-color:transparent}#navbar .nav-tabs-item[data-active=\"true\"]>.absolute{background-color:#ffffff}#navbar #search-bar-entry,#navbar #search-bar-entry-mobile{border-radius:0;background:transparent;color:rgba(255, 255, 255, 0.5);--tw-ring-color: rgba(255, 255, 255, 0.16);filter:none}#navbar #search-bar-entry:hover{--tw-ring-color: rgba(255, 255, 255, 0.32)}#navbar button,#navbar svg{color:inherit}#navbar #theme-preference-menu-trigger{color:rgba(255, 255, 255, 0.72)}#topbar-cta-button a{padding:0.5rem 1rem}#topbar-cta-button a>span.absolute{border-radius:0;background:transparent;border:1px solid rgba(255, 255, 255, 0.32);transition:background-color 150ms ease}#topbar-cta-button a:hover>span.absolute{opacity:1;background:rgba(255, 255, 255, 0.08)}#topbar-cta-button a svg{display:none}#topbar-cta-button a span.text-white{font-weight:400}#page-title{font-weight:900;letter-spacing:-0.02em;line-height:1.02}#content h2,#content h3{letter-spacing:-0.01em}#content h2{font-weight:900}html.dark #page-title,html.dark #content :is(h2,h3,h4){color:#ffffff}#content h3,#content h4{font-weight:700}code,pre,kbd,.font-mono{font-family:var(--voyager-mono)!important}.breadcrumb-item,.sidebar-group-header,#table-of-contents h2 button,#content table th{font-family:var(--voyager-mono);font-size:0.75rem;font-weight:400;text-transform:uppercase;letter-spacing:0.2em}.sidebar-group-header,#content table th{color:var(--voyager-ink)}#content a:not(.card):not([class*=\"button\"]):not(.not-prose a):not(h1 a):not(h2 a):not(h3 a):not(h4 a){color:var(--voyager-ink);font-weight:inherit;border-bottom:0;text-decoration:underline;text-decoration-color:color-mix(in srgb, var(--voyager-ink) 40%, transparent);text-decoration-thickness:1px;text-underline-offset:4px}#content a:not(.card):not([class*=\"button\"]):hover{text-decoration-color:var(--voyager-ink)}#sidebar li a,#table-of-contents a{text-shadow:none}#sidebar li[data-active=\"true\"]>a{border-radius:0;color:var(--voyager-ink);background:rgba(79, 87, 214, 0.12);box-shadow:inset 2px 0 0 #4f57d6}html.dark #sidebar li[data-active=\"true\"]>a{background:rgba(85, 96, 220, 0.24);box-shadow:inset 2px 0 0 #a3a9ff}#sidebar li a,#sidebar [class*=\"rounded\"]{border-radius:0}#content .card,#content .callout,#content .frame,#content .frame [class*=\"rounded\"],#content .frame img,#content pre,#content [class*=\"code-block\"],#content [class*=\"code-group\"],#content details,#content [class*=\"accordion\"],#content [data-component-part],#page-context-menu,#page-context-menu button,#pagination a,#footer [class*=\"rounded\"],[class*=\"rounded-2xl\"],[class*=\"rounded-xl\"]{border-radius:0!important}#content .card{background:var(--voyager-card);border-color:var(--voyager-line)}#content .card:hover{border-color:var(--voyager-line-strong);--tw-ring-color: transparent}#content .frame{background:transparent;border:1px solid var(--voyager-line)}#content .frame>.absolute{display:none}#content :not(pre)>code{background:var(--voyager-raised);color:var(--voyager-ink);border:0;border-radius:2px;padding:0.125rem 0.375rem;font-size:0.9em}#content .callout{background:var(--voyager-card);border:1px solid var(--voyager-line);border-left:2px solid var(--voyager-ink)}#content .callout,#content .callout [data-component-part=\"callout-content\"],#content .callout p,#content .callout li{color:var(--voyager-ink-muted)}#content .callout strong,#content .callout a{color:var(--voyager-ink)}#content table td{border-color:var(--voyager-line)}#content table th{border-color:var(--voyager-line-strong)}#content kbd{border-radius:0}#content .code-block{border-color:var(--voyager-line)}#content .code-block-background{background-color:var(--voyager-raised)!important}#content .code-block-fade-overlay{background-image:linear-gradient(to right, transparent 0, var(--voyager-raised) 32px)!important}#content details.accordion{background-color:var(--voyager-card)!important;border-color:var(--voyager-line)}#content details.accordion>summary:hover{background-color:rgba(79, 87, 214, 0.08)}html,body{background-color:#ffffff}html.dark,html.dark body{background-color:var(--voyager-deep)}"}],"page":{"pagePath":"api-reference/machines/run-command","slug":"/api-reference/machines/run-command","pageMetadata":{"title":"Run Command","description":"Run a command. With `wait: true` it answers with the output once the command ends (up to about 60 s; after\nthat it answers 202 with the running job). A paused machine is resumed first (`resumed: true`).","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/run","href":"/api-reference/machines/run-command","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Run a command. With \", _jsx(_components.code, {\n children: \"wait: true\"\n }), \" it answers with the output once the command ends (up to about 60 s; after\\nthat it answers 202 with the running job). A paused machine is resumed first (\", _jsx(_components.code, {\n children: \"resumed: true\"\n }), \").\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Run Command","description":"Run a command. With `wait: true` it answers with the output once the command ends (up to about 60 s; after\nthat it answers 202 with the running job). A paused machine is resumed first (`resumed: true`).","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/run","href":"/api-reference/machines/run-command","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["machines"],"summary":"Run Command","description":"Run a command. With `wait: true` it answers with the output once the command ends (up to about 60 s; after\nthat it answers 202 with the running job). A paused machine is resumed first (`resumed: true`).","operationId":"runCloudMachineCommand","security":["b4575cd8-3a3c-4f53-881b-1b176ad354b4"],"parameters":["2a70d763-c3f1-4c6b-b34a-e959e3037cf8","73819adc-5709-41ef-80db-9162ed67ec2d"],"requestBody":"572c1269-fdcf-4878-8eca-60de511e3178","responses":{"200":"37723ec1-2ec1-410b-b352-213877ee6f41","202":"828edf9e-4152-4ce6-8146-7ca54eacf6ec","400":"6c4c33c2-a67c-4f30-82b2-3efea09cd93e","401":"643900a0-77d7-4a55-bc95-e7c0e5eb979e","402":"652b5f31-edd7-4433-a087-71594bddf0dc","403":"19eaa077-fdee-4215-887c-d9819cd411d7","404":"3ac378f9-9621-42d7-9092-b060b217e54a","409":"9c0fbf6f-7132-4009-9e87-0530124bd940","429":"1fc35f5a-04d0-45e0-9138-07f6969c675c","503":"38a8c922-775a-4164-b283-90ac47b99f48"},"method":"post","type":"path","servers":["56c26eaa-dc5b-4cf6-9a68-62a920e59cdd"],"path":"/machines/{machine}/run","baseUrlOptions":["https://api.voyager.so/v1"],"title":"Run Command","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2a70d763-c3f1-4c6b-b34a-e959e3037cf8":{"name":"machine","in":"path","required":true,"schema":{"type":"string","title":"Machine","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"73819adc-5709-41ef-80db-9162ed67ec2d":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"Idempotency-Key","description":"Repeat a request safely: the same key and body return the original result.","maxLength":120,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Idempotency-Key","description":"Repeat a request safely: the same key and body return the original result.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Repeat a request safely: the same key and body return the original result."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"command":{"oneOf":[{"type":"string","title":"Command","description":"A shell command (run with `sh -c`).","maxLength":65536,"minLength":1,"uniqueKey":"command.oneOf.0","typeLabel":"string"},{"type":"null","title":"Command","description":"A shell command (run with `sh -c`).","uniqueKey":"command.oneOf.1","typeLabel":"null"}],"uniqueKey":"command","typeLabel":"string | null"},"argv":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"argv.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Argv","description":"Or an argv, no shell.","maxItems":4096,"minItems":1,"uniqueKey":"argv.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Argv","description":"Or an argv, no shell.","uniqueKey":"argv.oneOf.1","typeLabel":"null"}],"uniqueKey":"argv","typeLabel":"string[] | null"},"cwd":{"type":"string","maxLength":1024,"minLength":1,"title":"Cwd","default":"/project","description":"The working directory (default `/project`).","uniqueKey":"cwd","typeLabel":"string"},"env":{"additionalProperties":{"type":"string","uniqueKey":"env.additionalProperties","typeLabel":"string"},"type":"object","title":"Env","description":"Extra environment variables.","uniqueKey":"env","typeLabel":"Env · object"},"timeout":{"oneOf":[{"type":"integer","title":"Timeout","description":"Kill the command after N s.","maximum":604800,"minimum":1,"uniqueKey":"timeout.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Timeout","description":"Kill the command after N s.","uniqueKey":"timeout.oneOf.1","typeLabel":"null"}],"uniqueKey":"timeout","typeLabel":"integer | null"},"wait":{"type":"boolean","title":"Wait","description":"Wait up to about 60 s for it to finish and return its output; after that the running job.","default":false,"uniqueKey":"wait","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","title":"MachineRun","uniqueKey":"","typeLabel":"MachineRun · object"},"examples":{"Example":{"title":"Example","value":{"command":"\u003cstring>","argv":["\u003cstring>"],"cwd":"/project","env":{},"timeout":302400,"wait":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"37723ec1-2ec1-410b-b352-213877ee6f41":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"job_id":{"type":"string","title":"Job Id","description":"The job id (`mjb_…`).","isRequired":true,"uniqueKey":"job_id","typeLabel":"string"},"status":{"type":"string","enum":["succeeded","failed","canceled"],"title":"Status","description":"The state (see the enum).","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"exit_code":{"oneOf":[{"type":"integer","title":"Exit Code","description":"The command's exit code, once it has ended.","isRequired":true,"uniqueKey":"exit_code.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Exit Code","description":"The command's exit code, once it has ended.","isRequired":true,"uniqueKey":"exit_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"exit_code","typeLabel":"integer | null"},"stdout":{"type":"string","title":"Stdout","description":"The command's output (stderr is merged into it, in order).","isRequired":true,"uniqueKey":"stdout","typeLabel":"string"},"stderr":{"type":"string","title":"Stderr","description":"Always empty: stderr is merged into stdout.","isRequired":true,"uniqueKey":"stderr","typeLabel":"string"},"truncated":{"type":"boolean","title":"Truncated","description":"True when only the last 256 KB of output is returned.","isRequired":true,"uniqueKey":"truncated","typeLabel":"boolean"},"resumed":{"type":"boolean","title":"Resumed","description":"True when the machine was paused and resumed for this call.","isRequired":true,"uniqueKey":"resumed","typeLabel":"boolean"},"next":{"type":"string","title":"Next","description":"What to do next, for agents.","isRequired":true,"uniqueKey":"next","typeLabel":"string"}},"type":"object","required":["job_id","status","exit_code","stdout","stderr","truncated","resumed","next"],"title":"MachineRunResult","uniqueKey":"","typeLabel":"MachineRunResult · object"},"examples":{"Example":{"title":"Example","value":{"job_id":"\u003cstring>","status":"succeeded","exit_code":123,"stdout":"\u003cstring>","stderr":"\u003cstring>","truncated":true,"resumed":true,"next":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"828edf9e-4152-4ce6-8146-7ca54eacf6ec":{"description":"The job, still running.","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"The job id (`mjb_…`).","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"machine_id":{"type":"string","title":"Machine Id","description":"The machine id (`mch_…`).","isRequired":true,"uniqueKey":"machine_id","typeLabel":"string"},"status":{"type":"string","enum":["running","succeeded","failed","canceled"],"title":"Status","description":"The state (see the enum).","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"exit_code":{"oneOf":[{"type":"integer","title":"Exit Code","description":"The command's exit code, once it has ended.","isRequired":true,"uniqueKey":"exit_code.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Exit Code","description":"The command's exit code, once it has ended.","isRequired":true,"uniqueKey":"exit_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"exit_code","typeLabel":"integer | null"},"output_tail":{"oneOf":[{"type":"string","title":"Output Tail","description":"The last few KB of output (stdout and stderr together).","isRequired":true,"uniqueKey":"output_tail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Output Tail","description":"The last few KB of output (stdout and stderr together).","isRequired":true,"uniqueKey":"output_tail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"output_tail","typeLabel":"string | null"},"started_at":{"oneOf":[{"type":"string","title":"Started At","description":"When the job started running (ISO 8601); null while queued.","isRequired":true,"uniqueKey":"started_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Started At","description":"When the job started running (ISO 8601); null while queued.","isRequired":true,"uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"started_at","typeLabel":"string | null"},"ended_at":{"oneOf":[{"type":"string","title":"Ended At","description":"When it ended.","isRequired":true,"uniqueKey":"ended_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Ended At","description":"When it ended.","isRequired":true,"uniqueKey":"ended_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ended_at","typeLabel":"string | null"},"next":{"type":"string","title":"Next","description":"What to do next, for agents.","isRequired":true,"uniqueKey":"next","typeLabel":"string"},"resumed":{"type":"boolean","title":"Resumed","description":"True when the machine was paused and resumed for this run.","default":false,"uniqueKey":"resumed","typeLabel":"boolean"}},"type":"object","required":["id","machine_id","status","exit_code","output_tail","started_at","ended_at","next"],"title":"MachineJob","uniqueKey":"","typeLabel":"MachineJob · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","machine_id":"\u003cstring>","status":"running","exit_code":123,"output_tail":"\u003cstring>","started_at":"\u003cstring>","ended_at":"\u003cstring>","next":"\u003cstring>","resumed":false}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"6c4c33c2-a67c-4f30-82b2-3efea09cd93e":{"description":"The request is invalid (`INVALID_REQUEST`).","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"643900a0-77d7-4a55-bc95-e7c0e5eb979e":{"description":"Missing or invalid credential.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"652b5f31-edd7-4433-a087-71594bddf0dc":{"description":"Not enough credits (`INSUFFICIENT_CREDITS`); `details.upgrade_url` links to billing.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"19eaa077-fdee-4215-887c-d9819cd411d7":{"description":"This workspace needs a paid Voyager plan with a completed payment (`PLAN_REQUIRED`, `VERIFICATION_REQUIRED`; `details.upgrade_url`), or the key lacks a scope.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"3ac378f9-9621-42d7-9092-b060b217e54a":{"description":"No such machine, job or path.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"9c0fbf6f-7132-4009-9e87-0530124bd940":{"description":"The machine is in the wrong state for this (e.g. `MACHINE_NOT_READY`, `MACHINE_RELEASED`), or the Idempotency-Key was used for a different request.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"},"1fc35f5a-04d0-45e0-9138-07f6969c675c":{"description":"Rate limited; retry after `Retry-After` seconds.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"exampleType":"generated"},"38a8c922-775a-4164-b283-90ac47b99f48":{"description":"No capacity or a temporary outage; retry after `Retry-After` seconds.","content":{"application/json":{"schema":{"properties":{"error":{"properties":{"type":{"type":"string","enum":["invalid_request","authentication","permission","not_found","conflict","rate_limited","idempotency_conflict","unprocessable","upstream_error","internal_error"],"title":"ErrorType","description":"Stable category to branch on.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","enum":["invalid_request","invalid_input","content_policy","upstream_unavailable","rate_limited","queue_full","model_unavailable","model_not_found","insufficient_credits","paid_plan_required","model_not_in_plan","model_access_required","outcome_unknown","expired","not_found","conflict","forbidden","internal_error","catalog_unavailable","billing_unavailable","no_voyager_seat","credits_reloading","cast_not_supported","voice_cloning_unavailable","too_many_references","payload_too_large","upload_too_large","intake_full","invalid_url","fetch_failed","unsupported_file","invalid_api_key","idempotency_conflict","idempotency_in_flight","invalid_idempotency_key","invalid_cursor","invalid_webhook_url","method_not_allowed","account_unavailable","plan_required_for_faces","version_conflict","slug_taken","already_referenced","asset_in_use","upload_incomplete","cancel_unsupported","unsupported_model","invalid_job_id","voice_required","observation_timeout","reference_unavailable","queue_timeout","reference_missing"],"title":"Code","description":"Stable machine code; never renamed once published (x-voyager-errors lists each).","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"For developers. Not localized.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","title":"Doc Url","description":"https://docs.voyager.so/api/errors#\u003ccode>","isRequired":true,"uniqueKey":"error.doc_url","typeLabel":"string"},"request_id":{"oneOf":[{"type":"string","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Request Id","description":"Also in the X-Request-ID header; quote it to support.","uniqueKey":"error.request_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.request_id","typeLabel":"string | null"},"retryable":{"oneOf":[{"type":"boolean","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Retryable","description":"Whether the same request can succeed later.","uniqueKey":"error.retryable.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retryable","typeLabel":"boolean | null"},"retry_after_ms":{"oneOf":[{"type":"integer","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Retry After Ms","description":"How long to wait before retrying.","uniqueKey":"error.retry_after_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_ms","typeLabel":"integer | null"},"param":{"oneOf":[{"type":"string","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","title":"Param","description":"The request field at fault, as a path (e.g. input.resolution); set on invalid_input.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"details":{"oneOf":[{"type":"object","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","additionalProperties":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","description":"Code-specific detail, e.g. upgrade_url on a billing wall.","uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"Details · object | null"}},"type":"object","required":["type","code","message","doc_url"],"title":"ErrorBody","description":"What went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"ErrorBody · object"}},"type":"object","required":["error"],"title":"ErrorResponse","description":"Every non-2xx answer.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request","code":"invalid_request","message":"\u003cstring>","doc_url":"\u003cstring>","request_id":"\u003cstring>","retryable":true,"retry_after_ms":123,"param":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"headers":{"X-Request-ID":{"description":"This request's id (also error.request_id).","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Requests allowed per 60 seconds in this bucket (120 writes or 600 reads per minute per key).","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in this window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}}},"exampleType":"generated"}},"security":{"b4575cd8-3a3c-4f53-881b-1b176ad354b4":{"API Key":{"type":"http","description":"API key from Settings > Developer > REST API","scheme":"bearer","scopes":[],"schemeName":"API Key"}}},"servers":{"56c26eaa-dc5b-4cf6-9a68-62a920e59cdd":{"url":"https://api.voyager.so/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"API key from Settings > Developer > REST API","scheme":"bearer","scopes":[],"schemeName":"API Key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from Settings > Developer > REST API","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"API Key","name":"Authorization"}],"title":"API Key"}]},"originalFileLocation":"openapi/voyager-api.yaml"},"subdomain":"voyager","siteName":"Voyager","title":"Run Command - Voyager","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T01:10:55.057Z","originalFileLocation":"api-reference/machines/run-command.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 command. With wait: true it answers with the output once the command ends (up to about 60 s; after that it answers 202 with the running job). A paused machine is resumed first (resumed: true).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Voyager\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_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/voyager/07RWEvfTjoxzrBd9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run Command - Voyager\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run a command. With wait: true it answers with the output once the command ends (up to about 60 s; after that it answers 202 with the running job). A paused machine is resumed first (resumed: true).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Voyager\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voyager.so/api-reference/machines/run-command\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voyager.mintlify.site/_mintlify/api/og/v2?division=machines\u0026amp;title=Run+Command\u0026amp;description=Run+a+command.+With+%60wait%3A+true%60+it+answers+with+the+output+once+the+command+ends+%28up+to+about+60+s%3B+after%0Athat+it+answers+202+with+the+running+job%29.+A+paused+m\u0026amp;theme=40ba2a4ff630673b7c3f0463\u0026amp;signature=ddbd46b8676b516eb850a5de0c306785472eb4c241266da1709e505bf9b94571\">\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 Command - Voyager\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run a command. With wait: true it answers with the output once the command ends (up to about 60 s; after that it answers 202 with the running job). A paused machine is resumed first (resumed: true).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voyager.mintlify.site/_mintlify/api/og/v2?division=machines\u0026amp;title=Run+Command\u0026amp;description=Run+a+command.+With+%60wait%3A+true%60+it+answers+with+the+output+once+the+command+ends+%28up+to+about+60+s%3B+after%0Athat+it+answers+202+with+the+running+job%29.+A+paused+m\u0026amp;theme=40ba2a4ff630673b7c3f0463\u0026amp;signature=ddbd46b8676b516eb850a5de0c306785472eb4c241266da1709e505bf9b94571\">\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/voyager/07RWEvfTjoxzrBd9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Voyager\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F57D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voyager.so/api-reference/machines/run-command\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/machines/run-command.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voyager.so/#organization\",\"name\":\"Voyager\",\"url\":\"https://docs.voyager.so\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/voyager/dzNfJ3ErXafJEG4z/images/brand/logo-light.svg?fit=max\u0026auto=format\u0026n=dzNfJ3ErXafJEG4z\u0026q=85\u0026s=78ad7bf5f39a5663c58672e277398d3a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voyager.so#website\",\"name\":\"Voyager\",\"url\":\"https://docs.voyager.so\",\"publisher\":{\"@id\":\"https://docs.voyager.so/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voyager.so/api-reference/machines/run-command#webpage\",\"url\":\"https://docs.voyager.so/api-reference/machines/run-command\",\"name\":\"Run Command\",\"description\":\"Run a command. With wait: true it answers with the output once the command ends (up to about 60 s; after that it answers 202 with the running job). A paused machine is resumed first (resumed: true).\",\"dateModified\":\"2026-11-07T01:10:55.057Z\",\"isPartOf\":{\"@id\":\"https://docs.voyager.so#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voyager.so/api-reference/machines/run-command#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voyager.so/api-reference/machines/run-command#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.voyager.so/api-reference/models/list-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"machines\",\"item\":\"https://docs.voyager.so/api-reference/machines/list-presets\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Run Command\",\"item\":\"https://docs.voyager.so/api-reference/machines/run-command\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voyager.so/api-reference/machines/run-command#apireference\",\"headline\":\"Run Command\",\"name\":\"Run Command\",\"description\":\"Run a command. With wait: true it answers with the output once the command ends (up to about 60 s; after that it answers 202 with the running job). A paused machine is resumed first (resumed: true).\",\"url\":\"https://docs.voyager.so/api-reference/machines/run-command\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voyager.so/api-reference/machines/run-command#webpage\"},\"dateModified\":\"2026-11-07T01:10:55.057Z\",\"publisher\":{\"@id\":\"https://docs.voyager.so/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voyager.so#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Voyager\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Voyager","nav":{"global":{"anchors":[{"anchor":"Pricing","icon":"receipt","href":"https://voyager.so/pricing"},{"anchor":"Release notes","icon":"list","href":"https://github.com/usevoyager/voyager-releases/releases"}]},"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/chats-and-projects"}]},{"tab":"Connect your AI","pages":[{"title":"Connect your AI","href":"/connect/overview"}]},{"tab":"API","groups":[{"group":"Get started","pages":[{"title":"Voyager API","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Quickstart","href":"/api/quickstart"},{"title":"Authentication","href":"/api/authentication"},{"title":"Set up with your coding agent","sidebarTitle":"Coding agents","href":"/api/coding-agents"}]},{"group":"Concepts","pages":[{"title":"Jobs and polling","sidebarTitle":"Jobs and polling","href":"/api/jobs"},{"title":"Webhooks","href":"/api/webhooks"},{"title":"Models","href":"/api/models"},{"title":"Cast","href":"/api/cast"}]},{"group":"Reference","pages":[{"title":"Errors","href":"/api/errors"},{"title":"Rate limits and usage","sidebarTitle":"Rate limits and usage","href":"/api/rate-limits"},{"title":"Versioning","href":"/api/versioning"}]},{"group":"Cloud machines","pages":[{"title":"Cloud machines","sidebarTitle":"Overview","href":"/api/machines/overview"},{"title":"Cloud machines quickstart","sidebarTitle":"Quickstart","href":"/api/machines/quickstart"},{"title":"Machines and cost","sidebarTitle":"Machines and cost","href":"/api/machines/machines"},{"title":"Run commands","href":"/api/machines/commands"},{"title":"Files and ports","href":"/api/machines/files"},{"title":"Render with Vork on Voyager cloud GPUs","sidebarTitle":"Render with Vork","href":"/api/machines/vork"},{"title":"Cloud machines over MCP","sidebarTitle":"MCP setup","href":"/api/machines/mcp"},{"title":"Cloud machines API reference","sidebarTitle":"API reference","href":"/api/machines/reference"}]},{"group":"API reference","pages":[{"group":"Models","pages":[{"title":"List models","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /models","href":"/api-reference/models/list-models"},{"title":"Get a model","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /models/{model_id}","href":"/api-reference/models/get-a-model"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Create a job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /jobs","href":"/api-reference/jobs/create-a-job"},{"title":"Estimate a job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /estimate","href":"/api-reference/jobs/estimate-a-job"},{"title":"Get a job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /jobs/{job_id}","href":"/api-reference/jobs/get-a-job"},{"title":"Cancel a job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /jobs/{job_id}/cancel","href":"/api-reference/jobs/cancel-a-job"}]},{"group":"Files","pages":[{"title":"Upload or import a file","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /files","href":"/api-reference/files/upload-or-import-a-file"},{"title":"Complete an upload","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /files/{file_id}/complete","href":"/api-reference/files/complete-an-upload"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /files/{file_id}","href":"/api-reference/files/get-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml delete /files/{file_id}","href":"/api-reference/files/delete-a-file"},{"title":"Download a file","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /files/{file_id}/content","href":"/api-reference/files/download-a-file"},{"title":"Check a file download","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml head /files/{file_id}/content","href":"/api-reference/files/check-a-file-download"}]},{"group":"Cast","pages":[{"title":"List Cast","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /cast","href":"/api-reference/cast/list-cast"},{"title":"Create a Cast card","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /cast","href":"/api-reference/cast/create-a-cast-card"},{"title":"Get a Cast card","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /cast/{cast_id}","href":"/api-reference/cast/get-a-cast-card"},{"title":"Delete a Cast card","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml delete /cast/{cast_id}","href":"/api-reference/cast/delete-a-cast-card"},{"title":"Update a Cast card","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml patch /cast/{cast_id}","href":"/api-reference/cast/update-a-cast-card"},{"title":"Add a Cast reference","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /cast/{cast_id}/references","href":"/api-reference/cast/add-a-cast-reference"},{"title":"Remove a Cast reference","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml delete /cast/{cast_id}/references/{file_id}","href":"/api-reference/cast/remove-a-cast-reference"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /voices","href":"/api-reference/voices/list-voices"}]},{"group":"Account","pages":[{"title":"Get account","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /account","href":"/api-reference/account/get-account"}]},{"group":"machines","pages":[{"title":"List Presets","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/presets","href":"/api-reference/machines/list-presets"},{"title":"List Gpus","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/gpus","href":"/api-reference/machines/list-gpus"},{"title":"List Images","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/images","href":"/api-reference/machines/list-images"},{"title":"Get Job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/jobs/{job}","href":"/api-reference/machines/get-job"},{"title":"Get Job Logs","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/jobs/{job}/logs","href":"/api-reference/machines/get-job-logs"},{"title":"Cancel Job","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/jobs/{job}/cancel","href":"/api-reference/machines/cancel-job"},{"title":"List Machines","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines","href":"/api-reference/machines/list-machines"},{"title":"Create Machine","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines","href":"/api-reference/machines/create-machine"},{"title":"Get Machine","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml get /machines/{machine}","href":"/api-reference/machines/get-machine"},{"title":"Release Machine","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml delete /machines/{machine}","href":"/api-reference/machines/release-machine"},{"title":"Pause Machine","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/pause","href":"/api-reference/machines/pause-machine"},{"title":"Resume Machine","description":null,"deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/resume","href":"/api-reference/machines/resume-machine"},{"title":"Run Command","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/run","href":"/api-reference/machines/run-command"},{"title":"Upload Files","description":"Put files on the machine. Send files up to 4 MiB inline (`content_base64`); larger ones come back with an\n`upload_url` to PUT and an `upload_id` to commit (`POST …/files/upload/complete`). Unchanged files are skipped.","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/files/upload","href":"/api-reference/machines/upload-files"},{"title":"Complete Upload","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/files/upload/complete","href":"/api-reference/machines/complete-upload"},{"title":"Download Files","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/files/download","href":"/api-reference/machines/download-files"},{"title":"Open Port","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/ports","href":"/api-reference/machines/open-port"},{"title":"Snapshot Machine","deprecated":null,"version":null,"openapi":"/openapi/voyager-api.yaml post /machines/{machine}/snapshots","href":"/api-reference/machines/snapshot-machine"}]},{"group":"API Reference","pages":[{"title":"Jobsucceeded","version":null,"deprecated":null,"openapi":"/openapi/voyager-api.yaml webhook job.succeeded","href":"/api-reference/jobsucceeded"},{"title":"Jobfailed","version":null,"deprecated":null,"openapi":"/openapi/voyager-api.yaml webhook job.failed","href":"/api-reference/jobfailed"},{"title":"Jobcanceled","version":null,"deprecated":null,"openapi":"/openapi/voyager-api.yaml webhook job.canceled","href":"/api-reference/jobcanceled"}]}]}]},{"tab":"Account \u0026 billing","pages":[{"title":"Account \u0026 billing","href":"/account/accounts-and-agents"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/data-locations"}]},{"tab":"Help","pages":[{"title":"Help","href":"/help/troubleshooting"}]}]},"basePath":"","title":"Run Command - Voyager","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}