Unknown task ID, or a task belonging to another account.
409 invalid_request_error
The task already reached completed, failed, or cancelled.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PipeLLM","colors":{"primary":"#12B76A","light":"#3DF58F","dark":"#0E9152"},"logo":{"light":"https://mintcdn.com/pipellm/c14KpYQEcMuO-i7Z/logo/light.svg?fit=max\u0026auto=format\u0026n=c14KpYQEcMuO-i7Z\u0026q=85\u0026s=e63d66e7731e79c17fab3ac12709e0b1","dark":"https://mintcdn.com/pipellm/c14KpYQEcMuO-i7Z/logo/dark.svg?fit=max\u0026auto=format\u0026n=c14KpYQEcMuO-i7Z\u0026q=85\u0026s=3205f7a8fd0d53df4ccbd10fc7fff796"},"favicon":"https://mintcdn.com/pipellm/c14KpYQEcMuO-i7Z/favicon.svg?fit=max\u0026auto=format\u0026n=c14KpYQEcMuO-i7Z\u0026q=85\u0026s=696ba46d25b2028f32c94b319736a36c","api":{"params":{"expanded":"all"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"prefill":true},"mdx":{"auth":{"method":"bearer"},"server":"https://api.pipellm.ai"}},"appearance":{"default":"dark"},"background":{"color":{"light":"#FCFCFD","dark":"#05080A"}},"navbar":{"links":[{"href":"https://pipellm.ai/models","label":"Models"},{"href":"https://pipellm.ai/playground","label":"Playground"},{"href":"https://pipellm.ai/pricing","label":"Pricing"},{"href":"https://pipellm.ai/blog","label":"Blog"},{"href":"mailto:support@pipellm.ai","label":"Support"}],"primary":{"type":"button","label":"Console","href":"https://console.pipellm.ai"}},"footer":{"socials":{"x":"https://x.com/pipellm","github":"https://github.com/pipellm","linkedin":"https://linkedin.com/company/pipellm"}},"search":{},"fonts":{"heading":{"family":"Plus Jakarta Sans","weight":400},"body":{"family":"Plus Jakarta Sans","weight":400}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"languages":[{"language":"en","href":""},{"language":"zh","href":"zh"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pipellm","hasAudioNarration":false,"actualSubdomain":"pipellm","customDomains":["docs.pipellm.ai"],"gitSource":{"type":"github","owner":"pipellm-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ab0bf26528446e729be3cf7","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"en","tag":"API Reference","count":51},{"language":"zh","tag":"API 参考","count":51},{"language":"en","tag":"Relay","count":16},{"language":"zh","tag":"Relay","count":16},{"language":"en","tag":"Integrations","count":7},{"language":"zh","tag":"集成","count":7},{"language":"en","tag":"Guides","count":6},{"language":"en","tag":"WebSearch","count":6},{"language":"zh","tag":"指南","count":6},{"language":"zh","tag":"WebSearch","count":6},{"language":"en","tag":"API Guides","count":5},{"language":"en","tag":"Protocol Conversion","count":5},{"language":"zh","tag":"API 指南","count":5},{"language":"zh","tag":"协议转换","count":5},{"language":"en","tag":"Images","count":4},{"language":"en","tag":"Video","count":4},{"language":"zh","tag":"图像","count":4},{"language":"zh","tag":"视频","count":4},{"language":"en","tag":"V2 (Recommended)","count":3},{"language":"zh","tag":"V2(推荐)","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":".dark img[src*=\"/logo/providers/\"]{filter:brightness(0.715)}:root:root{--gray-50: 246 248 249;--gray-100: 240 243 244;--gray-200: 224 228 230;--gray-300: 206 211 214;--gray-400: 158 165 169;--gray-500: 112 119 123;--gray-600: 80 87 91;--gray-700: 62 69 73;--gray-800: 36 42 46;--gray-900: 22 27 30;--gray-950: 10 14 16}.dark{--default-border-color: rgb(252 252 253 / 0.14)}#request-example,#response-example{border-radius:0.75rem}method-pill,.method-pill{letter-spacing:0.04em}#pipellm-playground-mask{display:none}[data-pipellm-playground]>[role=\"presentation\"].bg-black\\/40{background:rgb(3 8 12 / 0.55)!important;backdrop-filter:blur(14px) saturate(1.2);-webkit-backdrop-filter:blur(14px) saturate(1.2);transition-duration:320ms!important}:root:not(.dark) [data-pipellm-playground]>[role=\"presentation\"].bg-black\\/40{background:rgb(248 250 250 / 0.55)!important}[data-pipellm-playground] [role=\"dialog\"]{border-radius:16px!important;box-shadow:0 0 0 1px rgb(255 255 255 / 0.08),\n 0 32px 96px rgb(0 0 0 / 0.55),\n 0 8px 24px rgb(0 0 0 / 0.35)!important;transition-property:transform, scale, translate, opacity!important;transition-duration:320ms!important;transition-timing-function:cubic-bezier(0.16, 1, 0.3, 1)!important}:root:not(.dark) [data-pipellm-playground] [role=\"dialog\"]{box-shadow:0 0 0 1px rgb(0 0 0 / 0.06),\n 0 32px 96px rgb(0 0 0 / 0.18),\n 0 8px 24px rgb(0 0 0 / 0.10)!important}[data-pipellm-playground] [role=\"dialog\"][data-starting-style]{opacity:0!important;scale:0.97!important;translate:0 18px!important}[data-pipellm-playground] [role=\"dialog\"][data-ending-style]{opacity:0!important;scale:0.985!important;translate:0 8px!important;transition-duration:180ms!important}"}],"page":{"pagePath":"api-reference/tasks/cancel","slug":"/api-reference/tasks/cancel","pageMetadata":{"title":"Cancel a task","api":"POST /v1/tasks/{task_id}/cancel","description":"Cancel an asynchronous task that has not finished.","i18n":"en","href":"/api-reference/tasks/cancel"},"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: \"Cancel an asynchronous task that has not finished.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,Heading,Info,ParamField}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Stops a task that is still `,_jsx(_components.code,{children:`pending`}),` or `,_jsx(_components.code,{children:`processing`}),`. A task that already reached a\nterminal state cannot be cancelled.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Video created through `,_jsx(_components.a,{href:`/api-reference/video/create`,children:_jsx(_components.code,{children:`POST /v2/videos`})}),` is cancelled\nwith `,_jsx(_components.code,{children:`DELETE /v2/videos/{id}`}),` instead.`]})}),`\n`,_jsx(ParamField,{path:`task_id`,type:`string`,required:true,id:`param-task-id`,children:_jsx(_components.p,{children:`Task ID, as returned when the task was created.`})}),`\n`,`\n`,`\n`,_jsxs(_components.p,{children:[`The response is the same task object returned by\n`,_jsx(_components.a,{href:`/api-reference/tasks/get`,children:_jsx(_components.code,{children:`GET /v1/tasks/{task_id}`})}),`, with `,_jsx(_components.code,{children:`status`}),` set to `,_jsx(_components.code,{children:`cancelled`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`billing`,children:`Billing`}),`\n`,_jsxs(_components.p,{children:[`Cancelling does not refund work the upstream provider already performed. For video, the\nquote is taken when the task is created — see `,_jsx(_components.a,{href:`/api-reference/model-pricing`,children:`Pricing`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Same envelope as `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),`.`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`404 not_found`,id:`404-not-found`,children:_jsx(_components.p,{children:`Unknown task ID, or a task belonging to another account.`})}),_jsx(Accordion,{title:`409 invalid_request_error`,id:`409-invalid-request-error`,children:_jsxs(_components.p,{children:[`The task already reached `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`failed`}),`, or `,_jsx(_components.code,{children:`cancelled`}),`.`]})})]})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Cancel a task","api":"POST /v1/tasks/{task_id}/cancel","description":"Cancel an asynchronous task that has not finished.","i18n":"en","href":"/api-reference/tasks/cancel"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading,Info,ParamField,RequestExample,ResponseExample}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!RequestExample)_missingMdxReference(`RequestExample`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Stops a task that is still `,_jsx(_components.code,{children:`pending`}),` or `,_jsx(_components.code,{children:`processing`}),`. A task that already reached a\nterminal state cannot be cancelled.`]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Video created through `,_jsx(_components.a,{href:`/api-reference/video/create`,children:_jsx(_components.code,{children:`POST /v2/videos`})}),` is cancelled\nwith `,_jsx(_components.code,{children:`DELETE /v2/videos/{id}`}),` instead.`]})}),`\n`,_jsx(ParamField,{path:`task_id`,type:`string`,required:true,id:`param-task-id`,children:_jsx(_components.p,{children:`Task ID, as returned when the task was created.`})}),`\n`,_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#DCDCAA`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` -X POST https://api.pipellm.ai/v1/tasks/gen-1732891234-abc123xyz/cancel \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:` -H `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"Authorization: Bearer $PIPELLM_API_KEY\"`})]}),`\n`]})})})}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"gen-1732891234-abc123xyz\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"cancelled\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"video_generation\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"model\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"seedance-2-0-mini\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"created_at\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"2026-09-17T08:14:02Z\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),`\n`,_jsxs(_components.p,{children:[`The response is the same task object returned by\n`,_jsx(_components.a,{href:`/api-reference/tasks/get`,children:_jsx(_components.code,{children:`GET /v1/tasks/{task_id}`})}),`, with `,_jsx(_components.code,{children:`status`}),` set to `,_jsx(_components.code,{children:`cancelled`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`billing`,children:`Billing`}),`\n`,_jsxs(_components.p,{children:[`Cancelling does not refund work the upstream provider already performed. For video, the\nquote is taken when the task is created — see `,_jsx(_components.a,{href:`/api-reference/model-pricing`,children:`Pricing`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(_components.p,{children:[`Same envelope as `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Errors`}),`.`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`404 not_found`,id:`404-not-found`,children:_jsx(_components.p,{children:`Unknown task ID, or a task belonging to another account.`})}),_jsx(Accordion,{title:`409 invalid_request_error`,id:`409-invalid-request-error`,children:_jsxs(_components.p,{children:[`The task already reached `,_jsx(_components.code,{children:`completed`}),`, `,_jsx(_components.code,{children:`failed`}),`, or `,_jsx(_components.code,{children:`cancelled`}),`.`]})})]})]})}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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Cancel a task","api":"POST /v1/tasks/{task_id}/cancel","description":"Cancel an asynchronous task that has not finished.","i18n":"en","href":"/api-reference/tasks/cancel"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Billing","slug":"billing","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes dark-plus dark-plus\" style=\"background-color:#0B0C0E;--shiki-dark-bg:#0B0C0E;color:#D4D4D4;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"2\">\u003cspan class=\"line\">\u003cspan style=\"color:#DCDCAA;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> -X POST https://api.pipellm.ai/v1/tasks/gen-1732891234-abc123xyz/cancel \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\"> -H \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"Authorization: Bearer $PIPELLM_API_KEY\"\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]},"response":{"type":"ResponseExample","children":[{"filename":"","html":"\u003cpre class=\"shiki shiki-themes dark-plus dark-plus\" style=\"background-color:#0B0C0E;--shiki-dark-bg:#0B0C0E;color:#D4D4D4;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"7\">\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"id\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"gen-1732891234-abc123xyz\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"status\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"cancelled\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"video_generation\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"model\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"seedance-2-0-mini\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#9CDCFE;--shiki-dark:#9CDCFE\"> \"created_at\"\u003c/span>\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#CE9178;--shiki-dark:#CE9178\">\"2026-09-17T08:14:02Z\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#D4D4D4;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Cancel a task","path":"/v1/tasks/{task_id}/cancel","servers":[{"url":"https://api.pipellm.ai"}],"method":"post","request":{"security":[{"title":"Bearer Auth","parameters":{"header":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{"task_id":{"schema":[{"type":"string","description":"Task ID, as returned when the task was created.","required":true}]}}},"body":{}},"response":{},"deprecated":false}},"jsLinks":["/_mintlify/custom/pipellm/df480d64db6c22d0/playground.js"],"subdomain":"pipellm","siteName":"PipeLLM","title":"Cancel a task - PipeLLM","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/tasks/cancel","matchLevel":0},"zh":{"href":"/zh/api-reference/tasks/cancel","matchLevel":1}}},"lastModified":"2026-09-19T04:58:56.436Z","originalFileLocation":"api-reference/tasks/cancel.mdx","locale":"en"},"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=\"dark\"}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=\"Cancel an asynchronous task that has not finished.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PipeLLM\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_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/pipellm/JKtU23MtMj4TtKyB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a task - PipeLLM\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel an asynchronous task that has not finished.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PipeLLM\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pipellm.ai/api-reference/tasks/cancel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pipellm.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Cancel+a+task\u0026amp;description=Cancel+an+asynchronous+task+that+has+not+finished.\u0026amp;theme=3c00a4b989b0438e6fc46fe4\u0026amp;signature=c75c4ac11b244015f11c6873c1066c67311e2c6911e35b8408a75f74fdb209d6\">\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=\"Cancel a task - PipeLLM\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel an asynchronous task that has not finished.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pipellm.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Cancel+a+task\u0026amp;description=Cancel+an+asynchronous+task+that+has+not+finished.\u0026amp;theme=3c00a4b989b0438e6fc46fe4\u0026amp;signature=c75c4ac11b244015f11c6873c1066c67311e2c6911e35b8408a75f74fdb209d6\">\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/pipellm/JKtU23MtMj4TtKyB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PipeLLM\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#12B76A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pipellm.ai/api-reference/tasks/cancel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tasks/cancel.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.pipellm.ai/api-reference/tasks/cancel\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.pipellm.ai/zh/api-reference/tasks/cancel\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.pipellm.ai/api-reference/tasks/cancel\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pipellm.ai/#organization\",\"name\":\"PipeLLM\",\"url\":\"https://docs.pipellm.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pipellm/c14KpYQEcMuO-i7Z/logo/light.svg?fit=max\u0026auto=format\u0026n=c14KpYQEcMuO-i7Z\u0026q=85\u0026s=e63d66e7731e79c17fab3ac12709e0b1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pipellm.ai#website\",\"name\":\"PipeLLM\",\"url\":\"https://docs.pipellm.ai\",\"publisher\":{\"@id\":\"https://docs.pipellm.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pipellm.ai/api-reference/tasks/cancel#webpage\",\"url\":\"https://docs.pipellm.ai/api-reference/tasks/cancel\",\"name\":\"Cancel a task\",\"description\":\"Cancel an asynchronous task that has not finished.\",\"dateModified\":\"2026-09-19T04:58:56.436Z\",\"isPartOf\":{\"@id\":\"https://docs.pipellm.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pipellm.ai/api-reference/tasks/cancel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pipellm.ai/api-reference/tasks/cancel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.pipellm.ai/api-reference/list-models\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tasks\",\"item\":\"https://docs.pipellm.ai/api-reference/tasks/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel a task\",\"item\":\"https://docs.pipellm.ai/api-reference/tasks/cancel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.pipellm.ai/api-reference/tasks/cancel#apireference\",\"headline\":\"Cancel a task\",\"name\":\"Cancel a task\",\"description\":\"Cancel an asynchronous task that has not finished.\",\"url\":\"https://docs.pipellm.ai/api-reference/tasks/cancel\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pipellm.ai/api-reference/tasks/cancel#webpage\"},\"dateModified\":\"2026-09-19T04:58:56.436Z\",\"publisher\":{\"@id\":\"https://docs.pipellm.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pipellm.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PipeLLM\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PipeLLM\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tasks/cancel.md","siteName":"PipeLLM","nav":{"global":null,"languages":[{"language":"en","tabs":[{"tab":"Relay","icon":"route","pages":[{"title":"Relay","href":""}]},{"tab":"API Reference","icon":"code","groups":[{"group":"API Guides","icon":"book-open","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":"book-open","href":"/api-reference/introduction"},{"title":"Streaming","sidebarTitle":"Streaming","icon":"list","href":"/api-reference/streaming"},{"title":"Authentication","sidebarTitle":"Authentication","icon":"lock","href":"/api-reference/authentication"},{"title":"Rate Limits","sidebarTitle":"Limits","icon":"gauge","href":"/api-reference/rate-limits"},{"title":"Errors and Debugging","sidebarTitle":"Errors and Debugging","icon":"triangle-alert","href":"/api-reference/errors"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Models","icon":"layers","pages":[{"title":"List models","api":"GET /v1/models","href":"/api-reference/list-models"},{"title":"Get model pricing","api":"GET /v1/models/pricing","href":"/api-reference/model-pricing"}]},{"group":"Chat Completions","icon":"/logo/providers/openai.svg","pages":[{"title":"Create a chat completion","api":"POST /v1/chat/completions","href":"/api-reference/openai/chat-completions"}]},{"group":"Responses","icon":"/logo/providers/openai.svg","pages":[{"title":"Create a response","api":"POST /v1/responses","href":"/api-reference/openai/responses"}]},{"group":"Anthropic","icon":"/logo/providers/anthropic.svg","pages":[{"title":"Create a message","api":"POST /v1/messages","href":"/api-reference/anthropic/messages"},{"title":"Tool Use","href":"/api-reference/anthropic/tool-use"}]},{"group":"Gemini","icon":"/logo/providers/gemini.svg","pages":[{"title":"Generate content","api":"POST /v1beta/models/{model}:generateContent","href":"/api-reference/gemini/generate-content"},{"title":"Stream generate content","api":"POST /v1beta/models/{model}:streamGenerateContent","href":"/api-reference/gemini/stream-generate-content"}]},{"group":"Images","icon":"image","pages":[{"title":"Create an image","api":"POST /v1/images/generations","href":"/api-reference/image/generations"},{"title":"Edit an image","api":"POST /v1/images/edits","href":"/api-reference/image/edits"},{"title":"Create an image variation","api":"POST /v1/images/variations","href":"/api-reference/image/variations"},{"title":"Generate an image with Gemini","api":"POST /v1beta/models/{model}:generateContent","href":"/api-reference/image/gemini"}]},{"group":"Jev / System One","icon":"brain","pages":[{"title":"Jev / System One","api":"POST /v1/systemone","href":"/api-reference/systemone"}]},{"group":"Video","icon":"clapperboard","pages":[{"group":"V2 (Recommended)","pages":[{"title":"Create a video","api":"POST /v2/videos","href":"/api-reference/video/create"},{"title":"Get a video","api":"GET /v2/videos/{id}","href":"/api-reference/video/get"},{"title":"Cancel a video","api":"DELETE /v2/videos/{id}","href":"/api-reference/video/cancel"}]},{"group":"V1 (Legacy)","pages":[{"title":"Create a video (V1)","api":"POST /v1/videos/generations","href":"/api-reference/video/create-v1"}]}]},{"group":"Tasks","icon":"list-checks","pages":[{"title":"Get a task","api":"GET /v1/tasks/{task_id}","description":"Poll the status of an asynchronous image, video, or audio task.","href":"/api-reference/tasks/get"},{"title":"Cancel a task","api":"POST /v1/tasks/{task_id}/cancel","href":"/api-reference/tasks/cancel"}]},{"group":"WebSearch","icon":"globe","pages":[{"title":"Deep search","api":"GET /v1/websearch/search","description":"Deep web search with content extraction and reranking.","href":"/websearch/search-api"},{"title":"Simple search","api":"GET /v1/websearch/simple-search","href":"/websearch/simple-search"},{"title":"Read a page","api":"GET /v1/websearch/reader","href":"/websearch/reader"},{"title":"Search news","api":"GET /v1/websearch/search-news","href":"/websearch/news-search"}]}]}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/integrations/overview"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/tasks/cancel"}]}]},"basePath":"","title":"Cancel a task - PipeLLM","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js"]}