List renders

GET

/v1/renders

const url = 'https://api.editsquare.com/v1/renders?limit=20&project_id=proj_j123456789&search=welcome&status=initializing&template_id=tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f&order=asc';
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://api.editsquare.com/v1/renders?limit=20&project_id=proj_j123456789&search=welcome&status=initializing&template_id=tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f&order=asc' \
  --header 'Authorization: Bearer <token>'

Lists the renders of one project, newest first.

Authorizations

apiKey

Parameters

Query Parameters

limit

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

integer

>= 1 <= 60

Example

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

cursor

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

string

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

project_id

required

Project ID

string

>= 1 characters

Example

proj_j123456789

Project ID

search

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

string

Example

welcome

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

status

Return only renders with this status.

string

Allowed values: initializing ready queued processing finalizing complete failed

Example

complete

Return only renders with this status.

template_id

Return only renders made from this template.

string

>= 1 characters

Example

tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f

Return only renders made from this template.

order

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

string

Allowed values: asc desc

Example

desc

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

Responses

200

A page of renders

application/json

object

data

required

Array<object>

object

required

string

name

required

string

status

required

string

Allowed values: initializing ready queued processing finalizing complete failed

type

required

string

Allowed values: local cloud

project

required

object

required

string

team

required

string

output

Signed URLs for the finished video, keyed by variant (the master plus any smaller encodes). Present once the render is complete. The URLs are time-limited.

object

key

additional properties

string

template_id

required

The template this render was made from. Null when the project rendered as it stands.

string | null

target

required

The key of the template target that rendered: the template’s first target when the request named none. Null without a template, and on renders from before targets.

string | null

values

required

The field values the render was requested with, by field key. Null without a template.

object | null

created_by

required

string | null

created_at

required

number

updated_at

required

number | null

has_more

required

Whether another page follows.

boolean

next_cursor

required

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

string | null

Example

{
  "data": [
    {
      "id": "rend_jh716ctpaqbye9aw64tgkqwtks7gvx7g",
      "name": "My New Shiny Render",
      "status": "initializing",
      "type": "local",
      "project": {
        "id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
        "team": "team_jn7fw41m8n5jtht7hxsy69tzg97gvef8"
      },
      "output": {
        "master": "https://files.editsquare.com/renders/rend_jh716ctpaqbye9aw64tgkqwtks7gvx7g/master.mp4?signature=..."
      },
      "template_id": "tpl_8f2c1d4e6a7b9c0d1e2f3a4b5c6d7e8f",
      "target": "story",
      "values": {
        "headline": "Summer sale",
        "hero": "https://example.com/hero.jpg"
      },
      "created_by": "user_k970b359khfwwny0q8fjah1hc97gtcwm",
      "created_at": 1748875980,
      "updated_at": 1748875986
    }
  ],
  "has_more": false
}