Poll a job

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

get/jobs/{id}

Request

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

Path parameters

idstring required

Response

The job.

idstring
namestring
status'active' | 'completed' | 'failed'
resultobject

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.

errorstring

Changes

No recorded changes to this operation across all 1 revision of this API.