Statuses: queued / processing / completed / failed. Instant Post type is render:instant_post.WebSocket wss://api.screencrafter.io/api/v1/ws?token=<sc_live_…> exists for API clients. MCP and Cursor should poll.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ScreenCrafter","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"favicon":"https://mintcdn.com/vantinc/BzAGpfwp0CLzipd5/favicon.svg?fit=max\u0026auto=format\u0026n=BzAGpfwp0CLzipd5\u0026q=85\u0026s=fbd8bd822d2ad8bbc621f74dfb1005a8","navbar":{"links":[{"href":"https://app.screencrafter.io","label":"Studio"},{"href":"https://screencrafter.io","label":"Site"}],"primary":{"type":"button","label":"Sign up","href":"https://app.screencrafter.io/signup"}},"footer":{"socials":{"x":"https://x.com/screencrafter","github":"https://github.com/hakimkal"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vantinc","hasAudioNarration":false,"actualSubdomain":"vantinc","customDomains":["docs.screencrafter.io"],"gitSource":{"type":"github","owner":"hakimkal","repo":"screencrafter-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a889487d0fd422d8927b8b1","collectionId":"fe920498-2d11-412f-b74e-332e3c8feb73","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a889487d0fd422d8927b8b1"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a889487d0fd422d8927b8b1:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Get started","count":4},{"language":"default","tag":"REST","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"rest-jobs","slug":"/rest-jobs","pageMetadata":{"title":"Jobs","description":"Poll REST jobs. MCP get_job is the same record.","href":"/rest-jobs"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Poll REST jobs. MCP get_job is the same record.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);return _jsxs(_Fragment,{children:[_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.screencrafter.io/api/v1/jobs?limit=10'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: sc_live_YOUR_KEY'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.screencrafter.io/api/v1/jobs/{id}`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-API-Key: sc_live_YOUR_KEY'`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Statuses: `,_jsx(_components.code,{children:`queued`}),` / `,_jsx(_components.code,{children:`processing`}),` / `,_jsx(_components.code,{children:`completed`}),` / `,_jsx(_components.code,{children:`failed`}),`. Instant Post type is `,_jsx(_components.code,{children:`render:instant_post`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`WebSocket `,_jsx(_components.code,{children:`wss://api.screencrafter.io/api/v1/ws?token=\u003csc_live_…>`}),` exists for API clients. MCP and Cursor should poll.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Jobs","description":"Poll REST jobs. MCP get_job is the same record.","href":"/rest-jobs"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"vantinc","siteName":"ScreenCrafter","title":"Jobs - ScreenCrafter","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T18:16:09.083Z","originalFileLocation":"rest-jobs.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=\"Poll REST jobs. MCP get_job is the same record.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ScreenCrafter\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_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/vantinc/50WuPJy-8Y4QQFMn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Jobs - ScreenCrafter\">\u003cmeta data-mint-head property=\"og:description\" content=\"Poll REST jobs. MCP get_job is the same record.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ScreenCrafter\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.screencrafter.io/rest-jobs\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vantinc.mintlify.app/_mintlify/api/og/v2?division=REST\u0026amp;title=Jobs\u0026amp;description=Poll+REST+jobs.+MCP+get_job+is+the+same+record.\u0026amp;theme=df44427d4ddbca4dea795833\u0026amp;signature=fed9e9dbe36981c54b2a627c34c7632832e975a5255e76149be7bf22666848ad\">\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=\"Jobs - ScreenCrafter\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Poll REST jobs. MCP get_job is the same record.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vantinc.mintlify.app/_mintlify/api/og/v2?division=REST\u0026amp;title=Jobs\u0026amp;description=Poll+REST+jobs.+MCP+get_job+is+the+same+record.\u0026amp;theme=df44427d4ddbca4dea795833\u0026amp;signature=fed9e9dbe36981c54b2a627c34c7632832e975a5255e76149be7bf22666848ad\">\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/vantinc/50WuPJy-8Y4QQFMn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ScreenCrafter\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.screencrafter.io/rest-jobs\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/rest-jobs.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.screencrafter.io/#organization\",\"name\":\"ScreenCrafter\",\"url\":\"https://docs.screencrafter.io\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.screencrafter.io#website\",\"name\":\"ScreenCrafter\",\"url\":\"https://docs.screencrafter.io\",\"publisher\":{\"@id\":\"https://docs.screencrafter.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.screencrafter.io/rest-jobs#webpage\",\"url\":\"https://docs.screencrafter.io/rest-jobs\",\"name\":\"Jobs\",\"description\":\"Poll REST jobs. MCP get_job is the same record.\",\"dateModified\":\"2026-08-21T18:16:09.083Z\",\"isPartOf\":{\"@id\":\"https://docs.screencrafter.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.screencrafter.io/rest-jobs#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.screencrafter.io/rest-jobs#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST\",\"item\":\"https://docs.screencrafter.io/rest\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Jobs\",\"item\":\"https://docs.screencrafter.io/rest-jobs\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.screencrafter.io/rest-jobs#article\",\"headline\":\"Jobs\",\"name\":\"Jobs\",\"description\":\"Poll REST jobs. MCP get_job is the same record.\",\"url\":\"https://docs.screencrafter.io/rest-jobs\",\"mainEntityOfPage\":{\"@id\":\"https://docs.screencrafter.io/rest-jobs#webpage\"},\"dateModified\":\"2026-08-21T18:16:09.083Z\",\"publisher\":{\"@id\":\"https://docs.screencrafter.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.screencrafter.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ScreenCrafter\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ScreenCrafter","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"ScreenCrafter API","href":"/index"},{"title":"Get started","href":"/quickstart"},{"title":"MCP","href":"/mcp-setup"},{"title":"Credits","href":"/credits"}]},{"group":"REST","pages":[{"title":"REST API","href":"/rest"},{"title":"Rest auth","href":"/rest-auth"},{"title":"Instant Post","href":"/rest-instant-post"},{"title":"Screenshots","description":"Sync URL capture. Typical cost 2 credits. Same key as Instant Post.","href":"/rest-screenshot"},{"title":"Jobs","href":"/rest-jobs"}]}]},"basePath":"","title":"Jobs - ScreenCrafter","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}