Docs
Log inStart free
API referenceScenes

What is on screen in this scene?

What is actually on screen at each requested time, as JSON — no screenshots.

Free; cached by composition content.

Per visible element (named by data-tc-anchor, data-wire-id, id, or tag.class plus its text): box on the composition canvas, fraction in frame, clipping by an overflow:hidden ancestor (and which), text overflow, glyph px when the frame is shown 360 px wide, contrast against the CSS paint underneath (null over an image), what covers it and which text it overlaps. Plus a sampled visibility timeline, fonts that failed to load, tc-wire conformance when a wire spec is present, and grouped one-line findings.

POST
/scenes/{sceneId}/frame-report

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

sceneId*string
Formatuuid

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

application/json

curl -X POST "https://example.com/scenes/497f6eca-6276-4993-bfeb-53cbbbba6f08/frame-report" \  -H "Content-Type: application/json" \  -d '{    "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"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

Everything known about a beat, before you author it GET

Return the authoring envelope for each of a scene's composition elements — what the pipeline's own composition author is told about the beat it is writing.

Render real frames of this scene POST

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