Browse the docs
Developers / Docs / Jobs & files
Cancel job
Cancels a job that is still queued and refunds what it was charged. Jobs that have started cannot be canceled.
Paste it into any AI assistant. The shortcuts open with the prompt typed in; nothing is sent until you press enter.
At a glance
- REST
POST https://api.clippie.ai/v1/jobs/:id/cancel
- MCP tool
cancel_job
- Scope
create
- Cost
- Spends nothing. Needs the
createscope.
- Spends nothing. Needs the
Parameters
id- In:
- path
- Type:
- string
- Required:
- Yes
- Description:
- The job id, job_… 1-80 chars.
Example
curl
curl https://api.clippie.ai/v1/jobs/job_abc123/cancel \
-H "Authorization: Bearer $CLIPPIE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'cancel-job.mjs
const auth = { Authorization: `Bearer ${process.env.CLIPPIE_API_KEY}` };
const res = await fetch('https://api.clippie.ai/v1/jobs/job_abc123/cancel', {
method: 'POST',
headers: { ...auth, 'Content-Type': 'application/json' },
body: JSON.stringify({}),
});
if (!res.ok) throw new Error((await res.json()).error.message);
console.log(await res.json());Response
200 with JSON. The full response schema is in the OpenAPI spec.
From an MCP client
Your AI calls cancel_job with the same fields as JSON arguments. See MCP server to connect one.
tools/call
{
"name": "cancel_job",
"arguments": {
"id": "job_abc123"
}
}