Get job
const url = 'https://reignitor.com/v1/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://reignitor.com/v1/job/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>'Returns the status of a render job. Poll this until status is succeeded,
failed or cancelled.
When status is succeeded, video_url is the finished MP4. A few seconds
between polls is enough; a render usually takes minutes, not seconds.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The job_id returned when you started the render.
Responses
Section titled “ Responses ”The job belongs to this account.
object
queued, starting and processing mean the render is still running.
succeeded, failed and cancelled are final.
Rough percentage complete.
URL of the finished MP4. Set when status is succeeded.
Why the job failed. Set when status is failed or cancelled.
Examples
Still rendering
{ "job_id": "7d2e4b10-5c3a-4f8e-a1b2-9c0d8e7f6a54", "status": "processing", "progress": 40, "video_url": null, "error": null}Finished
{ "job_id": "7d2e4b10-5c3a-4f8e-a1b2-9c0d8e7f6a54", "status": "succeeded", "progress": 100, "video_url": "https://cdn.example.com/exports/7d2e4b10.mp4", "error": null}Failed
{ "job_id": "7d2e4b10-5c3a-4f8e-a1b2-9c0d8e7f6a54", "status": "failed", "progress": 20, "video_url": null, "error": "Story render failed"}The key is missing, malformed, unknown or revoked.
Every error has a human-readable error. Most also have a machine-readable code.
object
A message you can show to a person.
A stable code to branch on. Not every error has one.
Extra context for some codes, such as retryAfter or usage figures.
Seconds to wait before retrying. Present on some RATE_LIMITED errors.
Examples
No key, or not an emp_ key
{ "error": "Unauthorized", "code": "NO_API_KEY"}Unknown or revoked key
{ "error": "Invalid or revoked API key", "code": "INVALID_API_KEY"}The key is valid but the account is not on the Agency plan.
Every error has a human-readable error. Most also have a machine-readable code.
object
A message you can show to a person.
A stable code to branch on. Not every error has one.
Extra context for some codes, such as retryAfter or usage figures.
Seconds to wait before retrying. Present on some RATE_LIMITED errors.
Example
{ "error": "API access is part of the Agency plan.", "code": "PLAN_UPGRADE_REQUIRED", "feature": "api_access", "plan": "pro"}The job exists but belongs to another account, or the account is suspended.
Every error has a human-readable error. Most also have a machine-readable code.
object
A message you can show to a person.
A stable code to branch on. Not every error has one.
Extra context for some codes, such as retryAfter or usage figures.
Seconds to wait before retrying. Present on some RATE_LIMITED errors.
Examples
{ "error": "Forbidden"}{ "error": "Account suspended", "code": "ACCOUNT_SUSPENDED"}No job with this ID.
Every error has a human-readable error. Most also have a machine-readable code.
object
A message you can show to a person.
A stable code to branch on. Not every error has one.
Extra context for some codes, such as retryAfter or usage figures.
Seconds to wait before retrying. Present on some RATE_LIMITED errors.
Example
{ "error": "Job not found"}Something went wrong on our side.
Every error has a human-readable error. Most also have a machine-readable code.
object
A message you can show to a person.
A stable code to branch on. Not every error has one.
Extra context for some codes, such as retryAfter or usage figures.
Seconds to wait before retrying. Present on some RATE_LIMITED errors.
Example
{ "error": "Something went wrong handling that request."}