API reference
Get job status
Where a job is, and what to do next.
GET /v1/jobs/{id}/status
Host https://api.open.sume.com · Auth API key
Returns the job's state, whether it is done, and when to look again. This is the call to poll; see Polling. The x-sume-poll-after header repeats next_poll_after_seconds.
Request
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer <key>. Or send x-api-key. |
Path
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The job id (job_...) from the submit response. |
Example
Get job status
GET /v1/jobs/{id}/status
Required
Response
200 OK
Errors
| Status | code | When |
|---|---|---|
| 401 | unauthorized | No key, or the key is wrong or revoked. |
| 404 | not_found | No job with that id in your workspace. |
| 429 | rate_limited | Too many requests for your key in this window. |