Get a render

GET

/v1/renders/{id}

const url = 'https://api.editsquare.com/v1/renders/rend_j123456789';
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/rend_j123456789 \
  --header 'Authorization: Bearer <token>'

Retrieves a single render, including its status and - once complete - the signed URLs of its output.

Authorizations

apiKey

Parameters

Path Parameters

required

Render ID

string

>= 1 characters

Example

rend_j123456789

Render ID

Responses

200

Retrieve the render

application/json

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

Example

{
  "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
}

404

Render not found

application/json

object

error

required

string

Example

{
  "error": "Render not found"
}