Renders
Read a render
Read a render. GET /v1/renders/{id} in the Raylight API.
GET
/v1/renders/{id}API key with the renders scope.
Parameters
| Field | In | Type | Description |
|---|---|---|---|
idrequired | path | uuid |
Responses
200The render, with a fresh video URL once done.
400Invalid request.
401Missing, invalid or revoked key.
403The key lacks the scope, or the key's owner has view-only access to the workspace (code
forbidden).404Not found.
429Rate limited, or a monthly cap reached.
200 response body
| Field | Type | Description |
|---|---|---|
renderrequired | object | |
render.idrequired | uuid | |
render.statusrequired | enum | One of: queued, rendering, done, failed |
render.progressrequired | number | |
render.projectIdrequired | uuid | null | |
render.resolutionrequired | enum | One of: 480p, 720p, 1080p, 4K |
render.errorrequired | string | null | |
render.videoUrl | url |
Example
curl https://api.raylight.app/v1/renders/$ID \ -H "Authorization: Bearer $RAYLIGHT_API_KEY"