API referenceCompositions

Render real frames of a draft composition

Real pixel frames, exactly as the final MP4 shows them: the same document, on the same GPU renderer, through the same capture pipeline.

Free.

Returns frames (one PNG URL per time); determinism — each check time taken cold vs after seeking elsewhere and back (seek-order), and before vs after the scripts run a second time (double-mount), pass/fail with PSNR, changed-pixel share and a diff image; kernels — what the kernels compiled and every moment they could not resolve; the checker's static findings; and a one-line summary.

For a draft you hold: times are on its own clock unless scene_id is given.

POST
/compositions/preview

Authorization

bearerAuth
AuthorizationBearer <token>

Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/compositions/preview" \  -H "Content-Type: application/json" \  -d '{    "html": "string",    "times": [      0    ]  }'
{
  "data": {
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}