Studio
Get Job
Read one job: its state, progress, result summary and up to 50 of its processed items in order. Pass items_cursor from a previous read to get the next 50 items.
queued and running jobs are not finished; poll until the state is succeeded, partially_succeeded or failed. stalled: true means the job has made no progress for over 10 minutes; it is retried and, if it stays stuck, failed automatically.
GET
job_id*Job IdJob id (job_...).
items_cursor?|Opaque cursor from a previous read's data.items_cursor. Omit for the first 50 items; pass back verbatim for the next.
Successful Response
application/json- response
Response for the get-job endpoint.
data*One job with a page of its items.
meta*Response metadata.
curl -X GET 'https://api.bettermenu.live/studio/jobs/string'Example Response
{ "data": { "id": "string", "kind": "custom_ingredient.pin_drift_scan", "subject": { "type": "custom_ingredient", "id": "string" }, "state": "queued", "stalled": true, "progress": { "total": 0, "done": 0, "failed": 0, "skipped": 0 }, "result": {}, "last_error": { "code": "string", "detail": "" }, "created_by": { "type": "string", "id": "string" }, "channel": "string", "created_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z", "heartbeat_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "redrives": 0, "items": [ { "seq": 0, "outcome": "succeeded", "subject_ref": {}, "detail": "", "produced": {} } ], "items_cursor": "string" }, "meta": { "version": "string", "request_id": "string", "timestamp": "string" }}