A job that has not started stops immediately. A running job has its
provider call interrupted. A job that finishes before cancellation
arrives keeps its result: cancel is a request, not a guarantee. A job
another batch also points to (a colleague asked for the same person)
is not cancelled: 409 job_shared, and it keeps running for them.
A cancelled line can be billed too: an earlier attempt that ran
before a restart, the Deep agent’s miss price when it had finished its
search, or a call whose answer landed as the cancel arrived. Its
credits.charged shows it.
API key ret_live_… created in Settings → API keys.
Path Parameters
id
string
required
Response
Status after cancellation.
job_id
string
service
string
status
enum<string>
Available options:
queued,
running,
completed,
failed,
cancelled
attempt
integer
Number of times the provider call started (the current claim included). Becomes 2 if a restart resumed a started job. A restart before the call started does not count.
reused
boolean
true when the answer came from one your organization already paid for (a recent answer, or a job another list started): nothing more was charged for this answer, and credits.charged keeps only what earlier attempts of its job paid (0 on a batch line that points to a job it did not create). On a batch line, also true for a line that points to a job another line or list created.
credits
object
Show child attributes
result
object
Present only if completed.
error
object
Present only if failed. Never a negative answer. The failed attempt costs nothing, except the Deep agent's miss price when a contact lookup's Deep agent finished its search. A call cut by a timeout can still be billed if the provider's answer lands just after the cut. A line that ends worker_lost can also be billed: its call may have run, and been paid, before the worker was lost. credits.charged gives what the line really cost, earlier attempts included.
Show child attributes
created_at
string<date-time>
started_at
string<date-time> | null
When the provider call first started. Null while the job waits.
completed_at
string<date-time> | null
ok
boolean
poll_url
string
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Retriever API","colors":{"primary":"#4F46E5"},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retriever-3987567e","hasAudioNarration":false,"actualSubdomain":"retriever-3987567e","customDomains":["docs.retriever.run"],"gitSource":{"type":"github","owner":"yonsy7","repo":"agentic-list-building","deployBranch":"master","contentDirectory":"docs/api/public","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afdd972374401a40709fe7c","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":65},{"language":"default","tag":"Plays","count":24},{"language":"default","tag":"Guides","count":20},{"language":"default","tag":"Runs","count":9},{"language":"default","tag":"Scheduled runs","count":9},{"language":"default","tag":"Services","count":9},{"language":"default","tag":"Concepts","count":8},{"language":"default","tag":"Recipes","count":8},{"language":"default","tag":"Go","count":4},{"language":"default","tag":"Workspaces","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":"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/services/cancel-a-service-job","slug":"/api-reference/services/cancel-a-service-job","pageMetadata":{"title":"Cancel a service job","description":"A job that has not started stops immediately. A running job has its\nprovider call interrupted. A job that finishes before cancellation\narrives keeps its result: cancel is a request, not a guarantee. A job\nanother batch also points to (a colleague asked for the same person)\nis not cancelled: `409 job_shared`, and it keeps running for them.\n\nA cancelled line can be billed too: an earlier attempt that ran\nbefore a restart, the Deep agent's miss price when it had finished its\nsearch, or a call whose answer landed as the cancel arrived. Its\n`credits.charged` shows it.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/{id}/cancel","href":"/api-reference/services/cancel-a-service-job","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"A job that has not started stops immediately. A running job has its\\nprovider call interrupted. A job that finishes before cancellation\\narrives keeps its result: cancel is a request, not a guarantee. A job\\nanother batch also points to (a colleague asked for the same person)\\nis not cancelled: \", _jsx(_components.code, {\n children: \"409 job_shared\"\n }), \", and it keeps running for them.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A cancelled line can be billed too: an earlier attempt that ran\\nbefore a restart, the Deep agent’s miss price when it had finished its\\nsearch, or a call whose answer landed as the cancel arrived. Its\\n\", _jsx(_components.code, {\n children: \"credits.charged\"\n }), \" shows it.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel a service job","description":"A job that has not started stops immediately. A running job has its\nprovider call interrupted. A job that finishes before cancellation\narrives keeps its result: cancel is a request, not a guarantee. A job\nanother batch also points to (a colleague asked for the same person)\nis not cancelled: `409 job_shared`, and it keeps running for them.\n\nA cancelled line can be billed too: an earlier attempt that ran\nbefore a restart, the Deep agent's miss price when it had finished its\nsearch, or a call whose answer landed as the cancel arrived. Its\n`credits.charged` shows it.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/{id}/cancel","href":"/api-reference/services/cancel-a-service-job","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Services"],"operationId":"cancelServiceJob","summary":"Cancel a service job","description":"A job that has not started stops immediately. A running job has its\nprovider call interrupted. A job that finishes before cancellation\narrives keeps its result: cancel is a request, not a guarantee. A job\nanother batch also points to (a colleague asked for the same person)\nis not cancelled: `409 job_shared`, and it keeps running for them.\n\nA cancelled line can be billed too: an earlier attempt that ran\nbefore a restart, the Deep agent's miss price when it had finished its\nsearch, or a call whose answer landed as the cancel arrived. Its\n`credits.charged` shows it.\n","parameters":["92c31aec-907c-4b01-8868-87b711cf2280"],"responses":{"200":"aedbcdc6-b978-4688-994a-72b1d10cd7e1","401":"c2662360-7820-4fed-8846-7209f32e9077","404":"83e1ee45-35f5-4830-8b01-bc9fa0750195","409":"4cc9773b-bb17-4585-b7dd-747e8fd6c8e0","413":"511ebfdc-e80f-4503-b540-273f09e86991","429":"a9a29961-8809-4909-b2f8-5db2ed923467"},"method":"post","type":"path","servers":["c882335a-db3f-4621-bd34-32f09c9bda3d","f703bce9-6e01-42ea-a3fe-83bb79e3226c"],"security":["0f18c5fc-2ff7-4893-a504-8f4e321ffab5"],"path":"/v1/services/jobs/{id}/cancel","baseUrlOptions":["https://api.retriever.run","http://localhost:4320"],"title":"Cancel a service job","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"92c31aec-907c-4b01-8868-87b711cf2280":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"aedbcdc6-b978-4688-994a-72b1d10cd7e1":{"description":"Status after cancellation.","content":{"application/json":{"schema":{"type":"object","properties":{"job_id":{"type":"string","uniqueKey":"job_id","typeLabel":"string"},"service":{"type":"string","uniqueKey":"service","typeLabel":"string"},"status":{"type":"string","enum":["queued","running","completed","failed","cancelled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"attempt":{"type":"integer","description":"Number of times the provider call started (the current claim included). Becomes 2 if a restart resumed a started job. A restart before the call started does not count.","uniqueKey":"attempt","typeLabel":"integer"},"reused":{"type":"boolean","description":"`true` when the answer came from one your organization already paid for (a recent answer, or a job another list started): nothing more was charged for this answer, and `credits.charged` keeps only what earlier attempts of its job paid (`0` on a batch line that points to a job it did not create). On a batch line, also `true` for a line that points to a job another line or list created.","uniqueKey":"reused","typeLabel":"boolean"},"credits":{"type":"object","properties":{"charged":{"oneOf":[{"type":"number","description":"Credits this request paid so far, over every attempt. `0` on a batch line that points to a job it did not create. A job answered from a recent answer keeps what its earlier attempts paid. A failed line shows here what it was charged, if anything. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent's miss price when it had finished its search, or a call whose answer landed as the cancel arrived. This field shows it. It can still grow after the job ends when a charge is recorded late, most often for a call cut by a timeout whose answer landed just after the cut. Late charges usually land within seconds, but this is not guaranteed: read it again a few minutes after the end. `GET /v1/services/jobs/{id}` shows the whole job's charge, even for a job you reached through reuse. `null` when the job's first call ran on a server from before this field; a job created before it but first run after shows a number. While this field was released, a job first claimed by a new server and then retried by an older one can show less than it cost.","uniqueKey":"credits.charged.oneOf.0","typeLabel":"number"},{"type":"null","description":"Credits this request paid so far, over every attempt. `0` on a batch line that points to a job it did not create. A job answered from a recent answer keeps what its earlier attempts paid. A failed line shows here what it was charged, if anything. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent's miss price when it had finished its search, or a call whose answer landed as the cancel arrived. This field shows it. It can still grow after the job ends when a charge is recorded late, most often for a call cut by a timeout whose answer landed just after the cut. Late charges usually land within seconds, but this is not guaranteed: read it again a few minutes after the end. `GET /v1/services/jobs/{id}` shows the whole job's charge, even for a job you reached through reuse. `null` when the job's first call ran on a server from before this field; a job created before it but first run after shows a number. While this field was released, a job first claimed by a new server and then retried by an older one can show less than it cost.","uniqueKey":"credits.charged.oneOf.1","typeLabel":"null"}],"uniqueKey":"credits.charged","typeLabel":"number | null"}},"uniqueKey":"credits","typeLabel":"object"},"result":{"type":"object","description":"Present only if `completed`.","uniqueKey":"result","typeLabel":"object"},"error":{"type":"object","description":"Present only if `failed`. Never a negative answer. The failed attempt costs nothing, except the Deep agent's miss price when a contact lookup's Deep agent finished its search. A call cut by a timeout can still be billed if the provider's answer lands just after the cut. A line that ends `worker_lost` can also be billed: its call may have run, and been paid, before the worker was lost. `credits.charged` gives what the line really cost, earlier attempts included.","properties":{"code":{"type":"string","description":"Retryable: `timeout`, `capacity`, `interrupted`, `provider_error`, `provider_unavailable`, `capability_error`, `service_error`, `service_execution_failed`, `worker_lost`, `usage_limit` (after a top-up). Not retryable: `provider_rejected`, `validation_error` (a value the service cannot search), `not_found` (what the input names does not exist), `invalid_output` (the service answered outside its own contract) and any other code.","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","description":"`true`: the same input can get an answer later (after a top-up for `usage_limit`), send it again in a new batch. `false`: it gets the same refusal.","uniqueKey":"error.retryable","typeLabel":"boolean"}},"uniqueKey":"error","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"started_at":{"oneOf":[{"type":"string","format":"date-time","description":"When the provider call first started. Null while the job waits.","uniqueKey":"started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the provider call first started. Null while the job waits.","uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"started_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"string\u003cdate-time> | null"},"ok":{"type":"boolean","uniqueKey":"ok","typeLabel":"boolean"},"poll_url":{"type":"string","uniqueKey":"poll_url","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"job_id":"\u003cstring>","service":"\u003cstring>","status":"queued","attempt":123,"reused":true,"credits":{"charged":123},"result":{},"error":{"code":"\u003cstring>","message":"\u003cstring>","retryable":true},"created_at":"2023-11-07T05:31:56Z","started_at":"2023-11-07T05:31:56Z","completed_at":"2023-11-07T05:31:56Z","ok":true,"poll_url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"c2662360-7820-4fed-8846-7209f32e9077":{"description":"`not_authenticated`: missing header, malformed (expected `Bearer \u003ckey>`), revoked or unknown key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_authenticated","message":"A valid API key is required."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_authenticated","message":"A valid API key is required."}}}},"exampleType":"examples"}},"exampleType":"examples"},"83e1ee45-35f5-4830-8b01-bc9fa0750195":{"description":"`not_found`: unknown job.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4cc9773b-bb17-4585-b7dd-747e8fd6c8e0":{"description":"`job_shared`: another batch of your organization points to this job; it is not cancelled.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"511ebfdc-e80f-4503-b540-273f09e86991":{"description":"`body_too_large`: the request body is over 10 MiB (10,485,760 bytes). Do not retry the same body: send less data per request.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"body_too_large","message":"The request body exceeds the 10 MiB limit (10485760 bytes)."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"body_too_large","message":"The request body exceeds the 10 MiB limit (10485760 bytes)."}}}},"exampleType":"examples"}},"exampleType":"examples"},"a9a29961-8809-4909-b2f8-5db2ed923467":{"description":"`rate_limited`: wait `Retry-After` seconds, then retry.","headers":{"Retry-After":{"schema":{"type":"integer"}},"RateLimit-Limit":{"schema":{"type":"integer"},"description":"Window budget."},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Remaining requests."},"RateLimit-Reset":{"schema":{"type":"integer"},"description":"Seconds until reset."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Rate limit exceeded. Retry in 12 s."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limit exceeded. Retry in 12 s."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0f18c5fc-2ff7-4893-a504-8f4e321ffab5":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key `ret_live_…` created in Settings → API keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c882335a-db3f-4621-bd34-32f09c9bda3d":{"url":"https://api.retriever.run","description":"Production"},"f703bce9-6e01-42ea-a3fe-83bb79e3226c":{"url":"http://localhost:4320","description":"Local app-server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key `ret_live_…` created in Settings → API keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key `ret_live_…` created in Settings → API keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"retriever-3987567e","siteName":"Retriever API","title":"Cancel a service job - Retriever API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T16:59:35.931Z","originalFileLocation":"api-reference/services/cancel-a-service-job.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=\"A job that has not started stops immediately. A running job has its provider call interrupted. A job that finishes before cancellation arrives keeps its result: cancel is a request, not a guarantee. A job another batch also points to (a colleague asked for the same person) is not cancelled: 409 job_shared, and it keeps running for them. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent\u0026#x27;s miss price when it had finished its search, or a call whose answer landed as the cancel arrived. Its credits.charged shows it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Retriever API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel a service job - Retriever API\">\u003cmeta data-mint-head property=\"og:description\" content=\"A job that has not started stops immediately. A running job has its provider call interrupted. A job that finishes before cancellation arrives keeps its result: cancel is a request, not a guarantee. A job another batch also points to (a colleague asked for the same person) is not cancelled: 409 job_shared, and it keeps running for them. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent\u0026#x27;s miss price when it had finished its search, or a call whose answer landed as the cancel arrived. Its credits.charged shows it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Retriever API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retriever.run/api-reference/services/cancel-a-service-job\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://retriever-3987567e.mintlify.site/_mintlify/api/og/v2?division=Services\u0026amp;title=Cancel+a+service+job\u0026amp;description=A+job+that+has+not+started+stops+immediately.+A+running+job+has+its%0Aprovider+call+interrupted.+A+job+that+finishes+before+cancellation%0Aarrives+keeps+its+result%3A\u0026amp;theme=a047e1d91cee8a1dafee7367\u0026amp;signature=ead4d71ab54357d49b61ff9706b1bf6496216ed934ae898e03cc719524e74967\">\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 service job - Retriever API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A job that has not started stops immediately. A running job has its provider call interrupted. A job that finishes before cancellation arrives keeps its result: cancel is a request, not a guarantee. A job another batch also points to (a colleague asked for the same person) is not cancelled: 409 job_shared, and it keeps running for them. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent\u0026#x27;s miss price when it had finished its search, or a call whose answer landed as the cancel arrived. Its credits.charged shows it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://retriever-3987567e.mintlify.site/_mintlify/api/og/v2?division=Services\u0026amp;title=Cancel+a+service+job\u0026amp;description=A+job+that+has+not+started+stops+immediately.+A+running+job+has+its%0Aprovider+call+interrupted.+A+job+that+finishes+before+cancellation%0Aarrives+keeps+its+result%3A\u0026amp;theme=a047e1d91cee8a1dafee7367\u0026amp;signature=ead4d71ab54357d49b61ff9706b1bf6496216ed934ae898e03cc719524e74967\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Retriever API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retriever.run/api-reference/services/cancel-a-service-job\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/services/cancel-a-service-job.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.retriever.run/#organization\",\"name\":\"Retriever API\",\"url\":\"https://docs.retriever.run\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.retriever.run#website\",\"name\":\"Retriever API\",\"url\":\"https://docs.retriever.run\",\"publisher\":{\"@id\":\"https://docs.retriever.run/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job#webpage\",\"url\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job\",\"name\":\"Cancel a service job\",\"description\":\"A job that has not started stops immediately. A running job has its provider call interrupted. A job that finishes before cancellation arrives keeps its result: cancel is a request, not a guarantee. A job another batch also points to (a colleague asked for the same person) is not cancelled: 409 job_shared, and it keeps running for them. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent's miss price when it had finished its search, or a call whose answer landed as the cancel arrived. Its credits.charged shows it.\",\"dateModified\":\"2026-11-18T16:59:35.931Z\",\"isPartOf\":{\"@id\":\"https://docs.retriever.run#website\"},\"breadcrumb\":{\"@id\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Services\",\"item\":\"https://docs.retriever.run/api-reference/services/list-services\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel a service job\",\"item\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job#apireference\",\"headline\":\"Cancel a service job\",\"name\":\"Cancel a service job\",\"description\":\"A job that has not started stops immediately. A running job has its provider call interrupted. A job that finishes before cancellation arrives keeps its result: cancel is a request, not a guarantee. A job another batch also points to (a colleague asked for the same person) is not cancelled: 409 job_shared, and it keeps running for them. A cancelled line can be billed too: an earlier attempt that ran before a restart, the Deep agent's miss price when it had finished its search, or a call whose answer landed as the cancel arrived. Its credits.charged shows it.\",\"url\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job\",\"mainEntityOfPage\":{\"@id\":\"https://docs.retriever.run/api-reference/services/cancel-a-service-job#webpage\"},\"dateModified\":\"2026-11-18T16:59:35.931Z\",\"publisher\":{\"@id\":\"https://docs.retriever.run/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.retriever.run#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Retriever API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Retriever API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/services/cancel-a-service-job.md","siteName":"Retriever API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Runs","pages":[{"title":"List runs","deprecated":null,"version":null,"sidebarTitle":"List runs","openapi":"/openapi.yaml get /v1/runs","href":"/api-reference/runs/list-runs"},{"title":"Start a run","deprecated":null,"version":null,"sidebarTitle":"Create run","openapi":"/openapi.yaml post /v1/runs","href":"/api-reference/runs/create-run"},{"title":"Get run status","deprecated":null,"version":null,"sidebarTitle":"Get run","openapi":"/openapi.yaml get /v1/runs/{id}","href":"/api-reference/runs/get-run"},{"title":"Request cancellation","deprecated":null,"version":null,"sidebarTitle":"Cancel run","openapi":"/openapi.yaml post /v1/runs/{id}/cancel","href":"/api-reference/runs/cancel-run"},{"title":"Get published output","deprecated":null,"version":null,"sidebarTitle":"Get run output","openapi":"/openapi.yaml get /v1/runs/{id}/output","href":"/api-reference/runs/get-run-output"},{"title":"Frozen table metadata","deprecated":null,"version":null,"sidebarTitle":"Get output table","openapi":"/openapi.yaml get /v1/runs/{id}/output/tables/{key}","href":"/api-reference/runs/get-output-table"},{"title":"Frozen table rows","deprecated":null,"version":null,"sidebarTitle":"List output table rows","openapi":"/openapi.yaml get /v1/runs/{id}/output/tables/{key}/rows","href":"/api-reference/runs/list-output-table-rows"},{"title":"Create a CSV or JSON export of a frozen table","deprecated":null,"version":null,"sidebarTitle":"Create export","openapi":"/openapi.yaml post /v1/runs/{id}/exports","href":"/api-reference/runs/create-export"},{"title":"Download an export","deprecated":null,"version":null,"sidebarTitle":"Download export","openapi":"/openapi.yaml get /v1/runs/{id}/exports/{exportId}","href":"/api-reference/runs/download-export"}]},{"group":"Tables","pages":[{"title":"Live table metadata","deprecated":null,"version":null,"sidebarTitle":"Get table","openapi":"/openapi.yaml get /v1/tables/{id}","href":"/api-reference/tables/get-table"},{"title":"Live table rows","deprecated":null,"version":null,"sidebarTitle":"List table rows","openapi":"/openapi.yaml get /v1/tables/{id}/rows","href":"/api-reference/tables/list-table-rows"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"sidebarTitle":"List workspaces","openapi":"/openapi.yaml get /v1/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"sidebarTitle":"Create workspace","openapi":"/openapi.yaml post /v1/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"List non-archived tables","deprecated":null,"version":null,"sidebarTitle":"List workspace tables","openapi":"/openapi.yaml get /v1/workspaces/{id}/tables","href":"/api-reference/workspaces/list-workspace-tables"},{"title":"Import a table (columns + JSON rows)","deprecated":null,"version":null,"sidebarTitle":"Import table","openapi":"/openapi.yaml post /v1/workspaces/{id}/tables","href":"/api-reference/workspaces/import-table"}]},{"group":"Exclusions","pages":[{"title":"List an exclusion list","deprecated":null,"version":null,"sidebarTitle":"List exclusions","openapi":"/openapi.yaml get /v1/exclusions/{kind}","href":"/api-reference/exclusions/list-exclusions"},{"title":"Add values (upsert)","deprecated":null,"version":null,"sidebarTitle":"Add exclusions","openapi":"/openapi.yaml post /v1/exclusions/{kind}","href":"/api-reference/exclusions/add-exclusions"},{"title":"Remove values","deprecated":null,"version":null,"sidebarTitle":"Remove exclusions","openapi":"/openapi.yaml post /v1/exclusions/{kind}/remove","href":"/api-reference/exclusions/remove-exclusions"}]},{"group":"Scheduled runs","pages":[{"title":"List scheduled runs","deprecated":null,"version":null,"sidebarTitle":"List scheduled runs","openapi":"/openapi.yaml get /v1/scheduled-runs","href":"/api-reference/scheduled-runs/list-scheduled-runs"},{"title":"Create a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Create scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs","href":"/api-reference/scheduled-runs/create-scheduled-run"},{"title":"Read a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Get scheduled run","openapi":"/openapi.yaml get /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/get-scheduled-run"},{"title":"Delete a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Delete scheduled run","openapi":"/openapi.yaml delete /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/delete-scheduled-run"},{"title":"Change a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Update scheduled run","openapi":"/openapi.yaml patch /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/update-scheduled-run"},{"title":"Start the cadence","deprecated":null,"version":null,"sidebarTitle":"Activate scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/activate","href":"/api-reference/scheduled-runs/activate-scheduled-run"},{"title":"Stop the cadence","deprecated":null,"version":null,"sidebarTitle":"Pause scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/pause","href":"/api-reference/scheduled-runs/pause-scheduled-run"},{"title":"Start an execution now","deprecated":null,"version":null,"sidebarTitle":"Run scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/run","href":"/api-reference/scheduled-runs/run-scheduled-run"},{"title":"List executions","deprecated":null,"version":null,"sidebarTitle":"List scheduled run executions","openapi":"/openapi.yaml get /v1/scheduled-runs/{id}/runs","href":"/api-reference/scheduled-runs/list-scheduled-run-executions"}]},{"group":"Plays","pages":[{"title":"List plays","deprecated":null,"version":null,"sidebarTitle":"List plays","openapi":"/openapi.yaml get /v1/plays","href":"/api-reference/plays/list-plays"},{"title":"Create a play","deprecated":null,"version":null,"sidebarTitle":"Create play","openapi":"/openapi.yaml post /v1/plays","href":"/api-reference/plays/create-play"},{"title":"What is new across plays","deprecated":null,"version":null,"sidebarTitle":"List play news","openapi":"/openapi.yaml get /v1/plays/news","href":"/api-reference/plays/list-play-news"},{"title":"Read a play","deprecated":null,"version":null,"sidebarTitle":"Get play","openapi":"/openapi.yaml get /v1/plays/{id}","href":"/api-reference/plays/get-play"},{"title":"Delete a play","deprecated":null,"version":null,"sidebarTitle":"Delete play","openapi":"/openapi.yaml delete /v1/plays/{id}","href":"/api-reference/plays/delete-play"},{"title":"Change a play","deprecated":null,"version":null,"sidebarTitle":"Update play","openapi":"/openapi.yaml patch /v1/plays/{id}","href":"/api-reference/plays/update-play"},{"title":"List a play's versions","deprecated":null,"version":null,"sidebarTitle":"List play versions","openapi":"/openapi.yaml get /v1/plays/{id}/versions","href":"/api-reference/plays/list-play-versions"},{"title":"Restore a play version","deprecated":null,"version":null,"sidebarTitle":"Restore play version","openapi":"/openapi.yaml post /v1/plays/{id}/versions/{version}/restore","href":"/api-reference/plays/restore-play-version"},{"title":"Launch a play","deprecated":null,"version":null,"sidebarTitle":"Launch play","openapi":"/openapi.yaml post /v1/plays/{id}/launch","href":"/api-reference/plays/launch-play"},{"title":"Pause a play","deprecated":null,"version":null,"sidebarTitle":"Pause play","openapi":"/openapi.yaml post /v1/plays/{id}/pause","href":"/api-reference/plays/pause-play"},{"title":"Run a play now","deprecated":null,"version":null,"sidebarTitle":"Run play now","openapi":"/openapi.yaml post /v1/plays/{id}/run","href":"/api-reference/plays/run-play-now"},{"title":"Resume a play","deprecated":null,"version":null,"sidebarTitle":"Resume play","openapi":"/openapi.yaml post /v1/plays/{id}/resume","href":"/api-reference/plays/resume-play"},{"title":"Archive a play","deprecated":null,"version":null,"sidebarTitle":"Archive play","openapi":"/openapi.yaml post /v1/plays/{id}/archive","href":"/api-reference/plays/archive-play"},{"title":"Restore a play","deprecated":null,"version":null,"sidebarTitle":"Restore play","openapi":"/openapi.yaml post /v1/plays/{id}/restore","href":"/api-reference/plays/restore-play"},{"title":"List a play's leads","deprecated":null,"version":null,"sidebarTitle":"List play leads","openapi":"/openapi.yaml get /v1/plays/{id}/leads","href":"/api-reference/plays/list-play-leads"},{"title":"Keep a lead","deprecated":null,"version":null,"sidebarTitle":"Accept play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/accept","href":"/api-reference/plays/accept-play-lead"},{"title":"Reject a lead","deprecated":null,"version":null,"sidebarTitle":"Reject play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/reject","href":"/api-reference/plays/reject-play-lead"},{"title":"Find someone else","deprecated":null,"version":null,"sidebarTitle":"Replace play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/replace","href":"/api-reference/plays/replace-play-lead"},{"title":"Rewrite a lead's message","deprecated":null,"version":null,"sidebarTitle":"Rewrite play lead message","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/message/rewrite","href":"/api-reference/plays/rewrite-play-lead-message"},{"title":"Save a lead's message","deprecated":null,"version":null,"sidebarTitle":"Save play lead message","openapi":"/openapi.yaml put /v1/plays/{id}/leads/{leadId}/message","href":"/api-reference/plays/save-play-lead-message"},{"title":"Rewrite the steps' instructions","deprecated":null,"version":null,"sidebarTitle":"Rewrite play step instructions","openapi":"/openapi.yaml post /v1/plays/{id}/steps/rewrite","href":"/api-reference/plays/rewrite-play-step-instructions"},{"title":"Move leads to the play's channel","deprecated":null,"version":null,"sidebarTitle":"Move play leads","openapi":"/openapi.yaml post /v1/plays/{id}/leads/move","href":"/api-reference/plays/move-play-leads"},{"title":"Apply a proposal","deprecated":null,"version":null,"sidebarTitle":"Apply play proposal","openapi":"/openapi.yaml post /v1/plays/{id}/proposals/{proposalId}/apply","href":"/api-reference/plays/apply-play-proposal"},{"title":"Dismiss a proposal","deprecated":null,"version":null,"sidebarTitle":"Dismiss play proposal","openapi":"/openapi.yaml post /v1/plays/{id}/proposals/{proposalId}/dismiss","href":"/api-reference/plays/dismiss-play-proposal"}]},{"group":"Go","pages":[{"title":"Synchronous structured research","deprecated":null,"version":null,"sidebarTitle":"Run sync","openapi":"/openapi.yaml post /v1/go/run","href":"/api-reference/go/run-sync"},{"title":"Asynchronous structured research","deprecated":null,"version":null,"sidebarTitle":"Create go run","openapi":"/openapi.yaml post /v1/go/runs","href":"/api-reference/go/create-go-run"},{"title":"Go job status","deprecated":null,"version":null,"sidebarTitle":"Get go run","openapi":"/openapi.yaml get /v1/go/runs/{id}","href":"/api-reference/go/get-go-run"},{"title":"Cancel a Go job","deprecated":null,"version":null,"sidebarTitle":"Cancel go run","openapi":"/openapi.yaml post /v1/go/runs/{id}/cancel","href":"/api-reference/go/cancel-go-run"}]},{"group":"Services","pages":[{"title":"Discover services","deprecated":null,"version":null,"sidebarTitle":"List services","openapi":"/openapi.yaml get /services","href":"/api-reference/services/list-services"},{"title":"Describe a service (input schema, cost)","deprecated":null,"version":null,"sidebarTitle":"Get service","openapi":"/openapi.yaml get /services/{serviceName}","href":"/api-reference/services/get-service"},{"title":"Execute a service","deprecated":null,"version":null,"sidebarTitle":"Execute service","openapi":"/openapi.yaml post /services/{serviceName}","href":"/api-reference/services/execute-service"},{"title":"List your service jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs","href":"/api-reference/services/list-your-service-jobs"},{"title":"Removed, send a list","deprecated":true,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs","href":"/api-reference/services/removed-send-a-list"},{"title":"Service job status and result","description":"One line of a batch on its own; the batch read already carries every\nline. A `failed` job has `error` instead of `result`, with `retryable`:\n`true` when the same input can get an answer later, sent again in a\nnew batch. What each code means and what to do is in the Errors page\n(batch lines). A job has 30 minutes from the real start of its provider\ncall, restarts included (the wait for a free place is not counted, up\nto two hours); a contact lookup's own call stops at 15 minutes. Past\neither, the job ends with `timeout` and is not run again.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs/{id}","href":"/api-reference/services/service-job-status-and-result"},{"title":"Cancel a service job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/{id}/cancel","href":"/api-reference/services/cancel-a-service-job"},{"title":"Run a slow service (a list of 1 to 100 inputs)","description":"The only way to run a slow service (`getEmail`, `getPhoneNumber`,\n`webResearch`):\n1 to 100 inputs in one call, one job per input, in the order sent. Put\nevery person of a task in the same list.\nEvery input is validated first; one bad input refuses the whole list\nwith its index, and no job is created.\n\nAn input the schema accepts but that names too little to search (a\ncontact with no LinkedIn profile, and no first and last name with a\ncompany) is not refused here: its line ends `provider_rejected`.\n\nEach line follows the job rules. For `getEmail` and `getPhoneNumber`\nonly, an answer your organization already has for that person from the\nlast 7 days is reused and the line comes back with\n`reused: true` (nothing more is charged for this answer), when it covers the request\n(an answer found by a database `databases` leaves out, or a \"not\nfound\" a chosen database has not searched, runs again). A `getPhoneNumber`\n\"not found\" whose waterfall holds a `skipped` database (one that could\nnot answer this time) never answers a request that runs that database:\nthe same person sent again searches again. `getPhoneNumber` stops at\nthe first database that finds a number, a landline as well as a\nmobile: to get another number, send the person again with\n`databases` leaving out the `source` of the number found. The stored\nanswer does not cover that request, and the database left out is not\ncalled, so it is not paid again. Other slow services never\nreuse a finished answer: they only share a search still running, like\nevery service does. A failed line is never reused: the same input sent\nagain gets a new job. The batch and its jobs are\ncreated together or not at all. `Retriever-Fresh: true` forces a\nfresh, billed execution of every line. Collect the results with\n`GET /v1/services/jobs/batch/{id}`. Requests and results are emptied\nafter 30 days.\n\nEach line reserves its worst-case price before its search. When the\nbalance cannot reserve even the cheapest line that needs a new search,\nthe whole list is refused with `402 insufficient_credits` and no job\nis created. Otherwise the list is accepted, and a line that finds no\nbalance left ends `failed` with `usage_limit`: top up, then send the\nfailed inputs again. Each line says what it cost in\n`credits.charged`, and the batch gives the total of its lines. A job\nthat two lines or two batches share counts once, on the line that\ncreated it. `GET /v1/services/jobs/{id}` shows that job's full charge:\nwhen you add up jobs across batches, count each `job_id` once. A\nline's amount can still grow after it ends when a charge is recorded\nlate, most often for a call cut by a timeout whose answer landed just\nafter the cut. Late charges usually land within seconds, but this is\nnot guaranteed: read it again a few minutes after the end. To compare with your balance, read\n\"Reconciling with GET /credits\" in the Runs page.\n\n`getPhoneNumber` returns every number its sources found in `phones`\n(number, country, line type, line status, `do_not_call` when the source\nflags the number, source), best first; `phone_number` is the first\nentry. Its price depends on the database that finds the number, up to\nthe listed price.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/batch","href":"/api-reference/services/run-a-slow-service-a-list-of-1-to-100-inputs"},{"title":"Batch status and results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs/batch/{id}","href":"/api-reference/services/batch-status-and-results"}]},{"group":"Credits","pages":[{"title":"Credit balance","deprecated":null,"version":null,"sidebarTitle":"Get credits","openapi":"/openapi.yaml get /credits","href":"/api-reference/credits/get-credits"}]}]}]},"basePath":"","title":"Cancel a service job - Retriever API","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}