API referenceJobs
Jobs
When you submit a render with async: true, you get a job back immediately. Poll it until status is done or failed, or skip polling entirely and let a webhook deliver the result.
Get a job
Authenticate with your x-api-key (or a session JWT). You can only read your own jobs.
GET
https://api.renderkit.tech/v1/jobs/:idGET /v1/jobs/:id
curl https://api.renderkit.tech/v1/jobs/rnd_8fk2m1c4 \
-H "x-api-key: $RK_KEY"Job status lifecycle
| Status | Meaning |
|---|---|
queued | Accepted and reserved; not yet started. |
processing | The engine is rendering. |
done | Finished — url or content is populated. |
failed | Render failed — see error; credits were refunded. |
200 · application/json
{
"success": true,
"data": {
"id": "rnd_8fk2m1c4",
"type": "screenshot",
"status": "done",
"url": "https://cdn.renderkit.tech/renders/3a7b9c…e9.png",
"meta": { "width": 1440, "height": 4860, "format": "png" },
"render_ms": 842,
"credits_used": 1,
"cached": false,
"created_at": "2026-06-14T10:24:00.000Z",
"completed_at": "2026-06-14T10:24:00.842Z"
},
"message": "Success"
}List render history
A paginated feed of your renders, newest first. This route is JWT-only (dashboard sessions). Inline data-URI artifacts are omitted from the list — fetch the single job for those.
GET
https://api.renderkit.tech/v1/jobsQuery parameters
| Parameter | Type | Description |
|---|---|---|
pageinteger | integer | 1-based page number. Defaults to 1. |
limitinteger | integer | Items per page (1–100). Defaults to 20. |
typestring | string | Filter by render type. Options: screenshot, pdf, extract. |
statusstring | string | Filter by job status. Options: queued, processing, done, failed. |
200 · application/json
{
"success": true,
"data": [
{ "job_id": "rnd_8fk2m1c4", "type": "screenshot", "status": "done", "credits_used": 1, "render_ms": 842, "created_at": "2026-06-14T10:24:00.000Z" }
],
"pagination": { "page": 1, "limit": 20, "total": 134, "pages": 7 }
}