API reference
Get a job result
The output of a completed job.
GET /v1/jobs/{id}/result
Host https://api.open.sume.com · Auth API key
Returns the artifacts of a completed job. Each artifact has a type, a content_type and a url on media.sume.com. Before the job completes, this answers 409 job_not_completed with the current status in details.
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 a job result
GET /v1/jobs/{id}/result
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. |
| 409 | job_not_completed | The job is queued, processing, failed or canceled. |
| 429 | rate_limited | Too many requests for your key in this window. |