Get the status of a Render

Images or videos can take some time to render. Images should typically be ready within seconds, however videos can take much longer.

When you submit a render through the API, you will receive a few details right away. This information includes details like the URL where you can download the generated file. Only after the render status is set to succeeded will the URL link to the finished file. In case of a problem, the status will be failed with a corresponding error_message.

You can monitor a render's status using two methods. The first method involves polling the API endpoint every few seconds to check for updates. The second, and recommended, method is to set up a webhook which will automatically notify you when renders complete or fail.

API endpoint

You can retrieve the status of a render using the following API endpoint. This endpoint requires the render ID, which is returned when the render is submitted.

curl -X GET https://api.creatomate.com/v2/renders/RENDER_ID \
     -H "Authorization: Bearer YOUR_API_KEY_HERE"

Response

The response of this API endpoint follows the same data structure as described here.

{
  "id": "a862048b-d0dc-4029-a4ef-e172e8ded827",
  "status": "succeeded",
  "url": "https://cdn.creatomate.com/renders/a862048b-d0dc-4029-a4ef-e172e8ded827.mp4",
  "snapshot_url": "https://cdn.creatomate.com/snapshots/a862048b-d0dc-4029-a4ef-e172e8ded827.jpg",
  "output_format": "mp4",
  "render_scale": 1,
  "width": 1280,
  "height": 720,
  "frame_rate": 60,
  "duration": 3,
  "file_size": 10804
}