Cancel a flow run that is currently running or pending. This immediately stops the flow and prevents any further processing.Use Cases:
Stop a flow that was started with incorrect parameters
Cancel a long-running flow that is no longer needed
Abort processing to avoid unnecessary credit consumption
Cancellable Statuses:
A flow run can be cancelled if it’s in one of these states:
CREATED - Flow is created but not yet started
QUEUED - Flow is waiting to be processed
SCHEDULED - Flow is scheduled for future execution
RUNNING - Flow is currently processing
Cancelling a flow run is irreversible. Any work already completed will be lost, and you will need to start a new flow run if you want to process the same inputs again.
Credits consumed before cancellation are not refunded. Cancel early to minimize credit usage.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Edges Flows","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/edges-49e4dfbb/45k-HA7Wlf7r9exb/logo/light.png?fit=max\u0026auto=format\u0026n=45k-HA7Wlf7r9exb\u0026q=85\u0026s=04483d03b73ca1bd4274f143cc534cec","dark":"https://mintcdn.com/edges-49e4dfbb/45k-HA7Wlf7r9exb/logo/dark.png?fit=max\u0026auto=format\u0026n=45k-HA7Wlf7r9exb\u0026q=85\u0026s=2de29cfde6eb8d24d8b0dd8596bfa804"},"favicon":"https://mintcdn.com/edges-49e4dfbb/45k-HA7Wlf7r9exb/favicon.png?fit=max\u0026auto=format\u0026n=45k-HA7Wlf7r9exb\u0026q=85\u0026s=f7e43ca4e6022dabca6fd804d6dc4157","navbar":{"links":[{"href":"mailto:support@edges.run","label":"Support"}],"primary":{"type":"button","label":"Flows App","href":"https://flows.edges.run"}},"footer":{},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"edges-49e4dfbb","hasAudioNarration":false,"actualSubdomain":"edges-49e4dfbb","customDomains":["flows-docs.edges.run"],"gitSource":{"type":"github","owner":"3dg3runn3r","repo":"edges-flows-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e8fd572b750f6b6ffb6c","collectionId":"828a3392-888a-4013-a16b-a21fe191b6f1","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e8fd572b750f6b6ffb6c:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"Flows Presets","count":13},{"language":"default","tag":"Runs \u0026 Schedules","count":10},{"language":"default","tag":"Flow Runs","count":6},{"language":"default","tag":"Flow Schedules","count":4},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Getting started","count":3},{"language":"default","tag":"API documentation","count":2},{"language":"default","tag":"Single Actions","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"api/runs/cancel","slug":"/api/runs/cancel","pageMetadata":{"title":"Cancel Flow Run","description":"Cancel a running or pending flow run","openapi":"POST /flows/runs/{flow_run_uid}/cancel","href":"/api/runs/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 a running or pending flow run\"\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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Note,Warning}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Cancel a flow run that is currently running or pending. This immediately stops the flow and prevents any further processing.`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Use Cases`}),`:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Stop a flow that was started with incorrect parameters`}),`\n`,_jsx(_components.li,{children:`Cancel a long-running flow that is no longer needed`}),`\n`,_jsx(_components.li,{children:`Abort processing to avoid unnecessary credit consumption`}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cancellable Statuses`}),`:\nA flow run can be cancelled if it’s in one of these states:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`CREATED`}),` - Flow is created but not yet started`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`QUEUED`}),` - Flow is waiting to be processed`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`SCHEDULED`}),` - Flow is scheduled for future execution`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`RUNNING`}),` - Flow is currently processing`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Cancelling a flow run is irreversible. Any work already completed will be lost, and you will need to start a new flow run if you want to process the same inputs again.`})}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Credits consumed before cancellation are not refunded. Cancel early to minimize credit usage.`})})]})}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":"Cancel Flow Run","description":"Cancel a running or pending flow run","openapi":"POST /flows/runs/{flow_run_uid}/cancel","href":"/api/runs/cancel"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"cancelFlowRun","summary":"Cancel a flow run","tags":["flows"],"parameters":["897f1f84-6db3-4123-9363-cdc909ceac55"],"responses":{"200":"14d68b29-aa69-49d2-bc33-517cfe5fc594","400":"20aac160-45b8-449f-82fd-c5135cb77a2c","500":"f4435332-84ec-4a4d-8cab-01b17602ccdd"},"method":"post","type":"path","servers":["b12ebfb9-3ef7-41d1-b542-8b0eb8650cfb"],"security":["9030e981-54b4-4e68-8cb5-80312c985711"],"path":"/flows/runs/{flow_run_uid}/cancel","baseUrlOptions":["https://api.edges.run/v1"],"title":"Cancel a flow run","description":"Cancel a running or pending flow run","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"897f1f84-6db3-4123-9363-cdc909ceac55":{"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Flow run UUID","uniqueKey":"","typeLabel":"string\u003cuuid>"},"in":"path","name":"flow_run_uid","required":true,"description":"Flow run UUID"}},"responses":{"14d68b29-aa69-49d2-bc33-517cfe5fc594":{"description":"Cancel the flow run","content":{"application/json":{"schema":{"description":"Cancel the flow run","type":"object","properties":{"uid":{"type":"string","format":"uuid","description":"Flow Run UUID","uniqueKey":"uid","typeLabel":"string\u003cuuid>"},"user_uid":{"type":"string","format":"uuid","description":"Member/User UUID","uniqueKey":"user_uid","typeLabel":"string\u003cuuid>"},"workspace_uid":{"type":"string","format":"uuid","description":"Workspace UUID","uniqueKey":"workspace_uid","typeLabel":"string\u003cuuid>"},"last_error":{"oneOf":[{"type":"object","description":"Last error message","properties":{"label":{"type":"string","description":"Label","uniqueKey":"last_error.oneOf.0.label","typeLabel":"string"},"message":{"type":"string","description":"Message","uniqueKey":"last_error.oneOf.0.message","typeLabel":"string"}},"uniqueKey":"last_error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Last error message","properties":{"label":{"type":"string","description":"Label"},"message":{"type":"string","description":"Message"}},"uniqueKey":"last_error.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_error","typeLabel":"object | null"},"callback":{"oneOf":[{"type":"object","description":"Callback","properties":{"url":{"type":"string","description":"Callback URL","uniqueKey":"callback.oneOf.0.url","typeLabel":"string"}},"uniqueKey":"callback.oneOf.0","typeLabel":"object"},{"type":"null","description":"Callback","properties":{"url":{"type":"string","description":"Callback URL"}},"uniqueKey":"callback.oneOf.1","typeLabel":"null"}],"uniqueKey":"callback","typeLabel":"object | null"},"status":{"oneOf":[{"type":"string","description":"Flow Run status","enum":["CREATED","INVALID","QUEUED","SCHEDULED","BLOCKED","STOPPED","RUNNING","FAILED","PARTIAL_SUCCEEDED","SUCCEEDED"],"uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Flow Run status","enum":["CREATED","INVALID","QUEUED","SCHEDULED","BLOCKED","STOPPED","RUNNING","FAILED","PARTIAL_SUCCEEDED","SUCCEEDED"],"uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"enum\u003cstring> | null"},"output_count":{"oneOf":[{"type":"integer","description":"Number of outputs generated by the flow run (only available when the flow run is finished)","default":0,"uniqueKey":"output_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of outputs generated by the flow run (only available when the flow run is finished)","default":0,"uniqueKey":"output_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"output_count","typeLabel":"integer | null"},"scheduled_flow_run_uid":{"oneOf":[{"type":"string","format":"uuid","description":"If the flow run is scheduled, this field indicates the scheduled flow run UUID.","uniqueKey":"scheduled_flow_run_uid.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"If the flow run is scheduled, this field indicates the scheduled flow run UUID.","uniqueKey":"scheduled_flow_run_uid.oneOf.1","typeLabel":"null"}],"uniqueKey":"scheduled_flow_run_uid","typeLabel":"string\u003cuuid> | null"},"started_at":{"oneOf":[{"type":"string","description":"Started at","uniqueKey":"started_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Started at","uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"started_at","typeLabel":"string | null"},"finished_at":{"oneOf":[{"type":"string","description":"Finished at","uniqueKey":"finished_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Finished at","uniqueKey":"finished_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"finished_at","typeLabel":"string | null"},"created_at":{"type":"string","description":"Created at","uniqueKey":"created_at","typeLabel":"string"},"updated_at":{"oneOf":[{"type":"string","description":"Updated at","uniqueKey":"updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"Updated at","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"uid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","user_uid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","workspace_uid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","last_error":{"label":"\u003cstring>","message":"\u003cstring>"},"callback":{"url":"\u003cstring>"},"status":"CREATED","output_count":0,"scheduled_flow_run_uid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","started_at":"\u003cstring>","finished_at":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"20aac160-45b8-449f-82fd-c5135cb77a2c":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"APIError","description":"Represents an error returned by the API. This schema defines the standard structure of error messages to ensure consistent error handling across the application.","type":"object","properties":{"error_label":{"oneOf":[{"type":"string","uniqueKey":"error_label.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_label","typeLabel":"string | null"},"error_scope":{"oneOf":[{"type":"string","enum":["input","integ","param","config"],"uniqueKey":"error_scope.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["input","integ","param","config"],"uniqueKey":"error_scope.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_scope","typeLabel":"enum\u003cstring> | null"},"error_ref":{"oneOf":[{"type":"string","example":"ERR-12345","uniqueKey":"error_ref.oneOf.0","typeLabel":"string"},{"type":"null","example":"ERR-12345","uniqueKey":"error_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_ref","typeLabel":"string | null"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status_code":{"oneOf":[{"type":"integer","uniqueKey":"status_code.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_code","typeLabel":"integer | null"},"params":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"params.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"}],"uniqueKey":"params.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | string[]"},"uniqueKey":"params.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"params.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"}],"uniqueKey":"params.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | string[]"},"uniqueKey":"params.oneOf.1","typeLabel":"null"}],"uniqueKey":"params","typeLabel":"object | null"},"data":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Additional data about the error","uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Additional data about the error","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"APIError · object"},"examples":{"Example":{"title":"Example","value":{"error_label":"\u003cstring>","error_scope":"input","error_ref":"ERR-12345","message":"\u003cstring>","status_code":123,"params":{},"data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"f4435332-84ec-4a4d-8cab-01b17602ccdd":{"description":"Internal Server Error","content":{"application/json":{"schema":{"title":"APIError","description":"Represents an error returned by the API. This schema defines the standard structure of error messages to ensure consistent error handling across the application.","type":"object","properties":{"error_label":{"oneOf":[{"type":"string","uniqueKey":"error_label.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"error_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_label","typeLabel":"string | null"},"error_scope":{"oneOf":[{"type":"string","enum":["input","integ","param","config"],"uniqueKey":"error_scope.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["input","integ","param","config"],"uniqueKey":"error_scope.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_scope","typeLabel":"enum\u003cstring> | null"},"error_ref":{"oneOf":[{"type":"string","example":"ERR-12345","uniqueKey":"error_ref.oneOf.0","typeLabel":"string"},{"type":"null","example":"ERR-12345","uniqueKey":"error_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_ref","typeLabel":"string | null"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"status_code":{"oneOf":[{"type":"integer","uniqueKey":"status_code.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"status_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"status_code","typeLabel":"integer | null"},"params":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"params.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"params.oneOf.0.additionalProperties.oneOf.4","typeLabel":"string[]"}],"uniqueKey":"params.oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | string[]"},"uniqueKey":"params.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"params.oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"string"},"uniqueKey":"params.oneOf.1.additionalProperties.oneOf.4","typeLabel":"string[]"}],"uniqueKey":"params.oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | string[]"},"uniqueKey":"params.oneOf.1","typeLabel":"null"}],"uniqueKey":"params","typeLabel":"object | null"},"data":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Additional data about the error","uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Additional data about the error","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"APIError · object"},"examples":{"Example":{"title":"Example","value":{"error_label":"\u003cstring>","error_scope":"input","error_ref":"ERR-12345","message":"\u003cstring>","status_code":123,"params":{},"data":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9030e981-54b4-4e68-8cb5-80312c985711":{"XApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}}},"servers":{"b12ebfb9-3ef7-41d1-b542-8b0eb8650cfb":{"url":"https://api.edges.run/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XApiKeyAuth","name":"X-API-Key"}],"title":"XApiKeyAuth"}]},"originalFileLocation":"api/actions.json"},"subdomain":"edges-49e4dfbb","siteName":"Edges Flows","title":"Cancel Flow Run - Edges Flows","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api/runs/cancel.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=\"Cancel a running or pending flow run\">\u003cmeta data-mint-head name=\"application-name\" content=\"Edges Flows\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel Flow Run - Edges Flows\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel a running or pending flow run\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Edges Flows\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://flows-docs.edges.run/api/runs/cancel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://edges-49e4dfbb.mintlify.app/_mintlify/api/og/v2?division=Flow+Runs\u0026amp;title=Cancel+Flow+Run\u0026amp;description=Cancel+a+running+or+pending+flow+run\u0026amp;theme=10d1e515d2f07da14f0c497e\u0026amp;signature=8305e3bc580168f930b0e9681740e0b002dbab6ba35e748b38cbf3999e7b6dd3\">\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 Flow Run - Edges Flows\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel a running or pending flow run\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://edges-49e4dfbb.mintlify.app/_mintlify/api/og/v2?division=Flow+Runs\u0026amp;title=Cancel+Flow+Run\u0026amp;description=Cancel+a+running+or+pending+flow+run\u0026amp;theme=10d1e515d2f07da14f0c497e\u0026amp;signature=8305e3bc580168f930b0e9681740e0b002dbab6ba35e748b38cbf3999e7b6dd3\">\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/edges-49e4dfbb/q13mhHwe4uaWX6Ce/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Edges Flows\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://flows-docs.edges.run/api/runs/cancel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/runs/cancel.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://flows-docs.edges.run/#organization\",\"name\":\"Edges Flows\",\"url\":\"https://flows-docs.edges.run\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/edges-49e4dfbb/45k-HA7Wlf7r9exb/logo/light.png?fit=max\u0026auto=format\u0026n=45k-HA7Wlf7r9exb\u0026q=85\u0026s=04483d03b73ca1bd4274f143cc534cec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://flows-docs.edges.run#website\",\"name\":\"Edges Flows\",\"url\":\"https://flows-docs.edges.run\",\"publisher\":{\"@id\":\"https://flows-docs.edges.run/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://flows-docs.edges.run/api/runs/cancel#webpage\",\"url\":\"https://flows-docs.edges.run/api/runs/cancel\",\"name\":\"Cancel Flow Run\",\"description\":\"Cancel a running or pending flow run\",\"isPartOf\":{\"@id\":\"https://flows-docs.edges.run#website\"},\"breadcrumb\":{\"@id\":\"https://flows-docs.edges.run/api/runs/cancel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://flows-docs.edges.run/api/runs/cancel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Runs \u0026 Schedules\",\"item\":\"https://flows-docs.edges.run/api/runs/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Flow Runs\",\"item\":\"https://flows-docs.edges.run/api/runs/list\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Cancel Flow Run\",\"item\":\"https://flows-docs.edges.run/api/runs/cancel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://flows-docs.edges.run/api/runs/cancel#apireference\",\"headline\":\"Cancel Flow Run\",\"name\":\"Cancel Flow Run\",\"description\":\"Cancel a running or pending flow run\",\"url\":\"https://flows-docs.edges.run/api/runs/cancel\",\"mainEntityOfPage\":{\"@id\":\"https://flows-docs.edges.run/api/runs/cancel#webpage\"},\"publisher\":{\"@id\":\"https://flows-docs.edges.run/#organization\"},\"isPartOf\":{\"@id\":\"https://flows-docs.edges.run#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Edges Flows\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Edges Flows","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/api/introduction"},{"title":"Webhooks \u0026 Callbacks","href":"/api/callbacks"}]},{"group":"Runs \u0026 Schedules","pages":[{"group":"Flow Runs","pages":[{"title":"List Flow Runs","openapi":"GET /flows/runs","href":"/api/runs/list"},{"title":"Get Flow Run","openapi":"GET /flows/runs/{flow_run_uid}","href":"/api/runs/get"},{"title":"Get Flow Run Status","openapi":"GET /flows/runs/{flow_run_uid}/status","href":"/api/runs/status"},{"title":"Flow Run Outputs","openapi":"GET /flows/runs/{flow_run_uid}/outputs","href":"/api/runs/outputs"},{"title":"Resume Flow Run","description":"Resume a paused or blocked flow run","openapi":"POST /flows/runs/{flow_run_uid}/resume","href":"/api/runs/resume"},{"title":"Cancel Flow Run","openapi":"POST /flows/runs/{flow_run_uid}/cancel","href":"/api/runs/cancel"}]},{"group":"Flow Schedules","pages":[{"title":"Schedule a Flow","description":"Schedule flows to run automatically at specific times or on recurring schedules","openapi":"POST /flows/{flow_slug}/run/schedule","href":"/api/schedules/create"},{"title":"List Scheduled Flows","openapi":"GET /flows/schedules","href":"/api/schedules/list"},{"title":"Get Schedule Details","openapi":"GET /flows/schedules/{scheduled_run_uid}","href":"/api/schedules/get"},{"title":"Manage Schedule","openapi":"POST /flows/schedules/{scheduled_flow_run_uid}/{action}","href":"/api/schedules/manage"}]}]},{"group":"Flows Presets","pages":[{"title":"Sales Navigator Search People","openapi":"POST /flows/salesnavigator-search-people/run/async","href":"/api/flows/salesnavigator-search-people"},{"title":"LinkedIn Domain to Company","openapi":"POST /flows/linkedin-domain-company/run/async","href":"/api/flows/linkedin-domain-company"},{"title":"LinkedIn Post Likers Enrich","openapi":"POST /flows/linkedin-post-likers-enrich/run/async","href":"/api/flows/linkedin-post-likers-enrich"},{"title":"LinkedIn Post Commenters Enrich","openapi":"POST /flows/linkedin-post-commenters-enrich/run/async","href":"/api/flows/linkedin-post-commenters-enrich"},{"title":"LinkedIn Page Followers Enrich","openapi":"POST /flows/linkedin-page-followers-enrich/run/async","href":"/api/flows/linkedin-page-followers-enrich"},{"title":"LinkedIn People Enrich","openapi":"POST /flows/linkedin-people-enrich/run/async","href":"/api/flows/linkedin-people-enrich"},{"title":"LinkedIn Find People Enrich","openapi":"POST /flows/linkedin-find-people-enrich/run/async","href":"/api/flows/linkedin-find-people-enrich"},{"title":"Sales Navigator Lead List Enrich","openapi":"POST /flows/salesnavigator-leadlist-enrich/run/async","href":"/api/flows/salesnavigator-leadlist-enrich"},{"title":"Sales Navigator Search Employees","openapi":"POST /flows/salesnavigator-search-employees/run/async","href":"/api/flows/salesnavigator-search-employees"},{"title":"LinkedIn Domain Employees Enrich","openapi":"POST /flows/linkedin-domain-employees-enrich/run/async","href":"/api/flows/linkedin-domain-employees-enrich"},{"title":"LinkedIn Hiring Companies Enrich","openapi":"POST /flows/linkedin-hiring-companies-enrich/run/async","href":"/api/flows/linkedin-hiring-companies-enrich"},{"title":"LinkedIn Content Search Enrich","openapi":"POST /flows/linkedin-content-search-enrich/run/async","href":"/api/flows/linkedin-content-search-enrich"},{"title":"Google Maps Places Enrich","openapi":"POST /flows/google-maps-places-enrich/run/async","href":"/api/flows/google-maps-places-enrich"}]},{"group":"Single Actions","pages":[{"title":"Fullenrich Enrich People","openapi":"POST /actions/fullenrich-enrich-people/run/async","href":"/api/actions/fullenrich-enrich-people"}]}]}]},"basePath":"","title":"Cancel Flow Run - Edges Flows","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}