Browse the docs
Developers / Docs / Jobs & files
List jobs
Lists the jobs started through the API or MCP, newest first, with their status, output and what they cost. Filter by status or kind.
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
GET https://api.clippie.ai/v1/jobs
- MCP tool
list_jobs
- Scope
read
- Cost
- Free. Works with a read-only key.
Parameters
status- In:
- query
- Type:
- string
- Required:
- No
- Description:
- One of
queued,processing,rendering,completed,failed,canceled.
kind- In:
- query
- Type:
- string
- Required:
- No
- Description:
- Up to 40 chars.
limit- In:
- query
- Type:
- integer
- Required:
- No
- Description:
- How many to return, 1-100. Default 25. 1-100.
cursor- In:
- query
- Type:
- string
- Required:
- No
- Description:
nextCursorfrom the previous page. Up to 500 chars.
Example
curl
curl "https://api.clippie.ai/v1/jobs?status=completed&limit=10" \
-H "Authorization: Bearer $CLIPPIE_API_KEY"list-jobs.mjs
const auth = { Authorization: `Bearer ${process.env.CLIPPIE_API_KEY}` };
const res = await fetch('https://api.clippie.ai/v1/jobs?status=completed&limit=10', { headers: auth });
if (!res.ok) throw new Error((await res.json()).error.message);
console.log(await res.json());Response
200 { data, nextCursor }. Pass nextCursor as cursor for the next page. The item shape is in the OpenAPI spec.
From an MCP client
Your AI calls list_jobs with the same fields as JSON arguments. See MCP server to connect one.
tools/call
{
"name": "list_jobs",
"arguments": {
"status": "completed",
"limit": 10
}
}