Skip to main content
GET
/
v1
/
renders
List renders
curl --request GET \
  --url https://roughy-api-staging.fly.dev/v1/renders \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cut_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "output": {
        "frame_rate": 120
      },
      "size_bytes": 123,
      "error_code": "<string>",
      "error_message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

​
Authorization
string
header
required

Pass your API key as Authorization: Bearer sk_…. Mint a key from your dashboard's API-keys page.

Query Parameters

​
asset_id
string<uuid>
required

The asset whose renders to list.

​
limit
integer
default:20

Maximum renders to return (1-100). Default 20.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Renders to skip from the start. Default 0.

Required range: x >= 0

Response

One page of an asset's renders, newest first.

Paginated list of an asset's renders, newest first.

​
items
RenderResponse · object[]
required

Page of renders, newest first.

​
total
integer
required

Total number of renders for this asset across all pages — not the size of items.

​
limit
integer
required

The limit echoed back from the request.

​
offset
integer
required

The offset echoed back from the request.