Renders

Create a new render

Queues a render of a project. Pass template_id and values to render the project with a form submission applied; omit both to render it as it stands.

post/v1/renders

Request

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

Request body

namestring required
project_idstring required
template_idstring
valuesobject

Response

Render created successfully

idstring required
namestring required
status'initializing' | 'ready' | 'queued' | 'processing' | 'finalizing' | 'complete' | 'failed' required
type'local' | 'cloud' required
outputobject

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.

created_bystring nullable required
created_atnumber required
updated_atnumber nullable required

Example response

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