---
title: "Poll a job"
method: GET
path: "/jobs/{id}"
---

# Poll a job

`GET /jobs/{id}`

## Request

- Base URL: `https://creadal.com/api/v1`
- URL: `https://creadal.com/api/v1/jobs/{id}`
- Auth: HTTP bearer

Any valid key can poll jobs the API itself started (generation, document export). A completed generation job's result carries designId and editorUrl.

## Path parameters

- `id` string, required

## Response `200`

The job.

- Job
  - `id` string
  - `name` string
  - `status` 'active' | 'completed' | 'failed'
  - `result` object: On completion of a generation job: { designId, title, pageCount, editorUrl, quality, images }. quality is the composer's verdict on the saved deck: { ok, stillLong (pages whose copy is still long after one shortening pass), bulletShare (share of pages set as plain bullets) }. images reports the picture regions: { requested, placed, reused, stock, generated, unsupported }; a region that could not be filled keeps its stand-in and can be filled in the editor, and unsupported is true when the workspace's provider cannot generate images at all.
  - `error` string

## Other responses

- `404`: Unknown job (or another user's).

---

[API](https://skmtc.dev/creadal/apis/creadal-generation-api.md) · [All operations](https://skmtc.dev/creadal/apis/creadal-generation-api/llms.txt) · [OpenAPI document](https://skmtc.dev/creadal/apis/creadal-generation-api/revisions/703dfc723415?raw)