Renders

List renders

Lists the renders of one project, newest first.

get/v1/renders

Request

  • Base URL: https://api.editsquare.com
  • URL: https://api.editsquare.com/v1/renders
  • Auth: HTTP bearer

Query parameters

limitinteger

How many to return. 1–60, 20 by default.

Example:20
cursorstring

The next_cursor of the previous page. Omit for the first page.

project_idstring required

Project ID

Example:proj_j123456789
searchstring

Filter by name. Matches are returned by relevance rather than by date.

Example:welcome
status'initializing' | 'ready' | 'queued' | 'processing' | 'finalizing' | 'complete' | 'failed'

Return only renders with this status.

Example:complete
order'asc' | 'desc'

Oldest or newest first. Newest by default, and ignored when search is set.

Example:desc

Response

A page of renders

has_moreboolean required

Whether another page follows.

next_cursorstring nullable required

Pass as cursor to read the next page. Null on the last page.

Example response

{
  "data": [
    {
      "id": "rend_jh716ctpaqbye9aw64tgkqwtks7gvx7g",
      "name": "My New Shiny Render",
      "project": {
        "id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
        "team": "team_jn7fw41m8n5jtht7hxsy69tzg97gvef8"
      },
      "output": {
        "master": "https://files.editsquare.com/renders/rend_jh716ctpaqbye9aw64tgkqwtks7gvx7g/master.mp4?signature=..."
      },
      "created_by": "user_k970b359khfwwny0q8fjah1hc97gtcwm",
      "created_at": 1748875980,
      "updated_at": 1748875986
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.