API referenceScenes

Lift an imported HTML slice into a standalone scene

import_html tier 3. An LLM pass writes the slice's window of the original file as a standalone composition on local time.

It lands only if every compared frame is at or above min_psnr (default 36 dB, the HyperFrames conformance bar) against the slice, both rendered in the scene on the production renderer; otherwise the slice stays. candidate_url holds the attempt either way. Asynchronous: the first call starts it (202, status running); the same call again returns progress, then the result (200); retry starts a new attempt. dry_run diffs without landing. Staff and authoring-pilot accounts.

POST
/scenes/{sceneId}/extract-html

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/extract-html" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {}
}
{
  "data": {}
}
{
  "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"
  }
}