API referenceChapters

Export a chapter as one embeddable sequence

Publish a whole chapter as ONE embeddable block: its scenes play back to back on one clock, mounted a window at a time (WebGL, Pixi and project modules included), with the chapter voice and the project music carried across scene boundaries.

Every scene must be HTML you authored. Returns a hosted embed_url (opens a play page in a browser) and the two-line snippet; the page gets block.play/pause/seek(sec). Re-exporting keeps the embed_url. dry_run runs the gate only. Free.

POST
/chapters/{chapterId}/web-block

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

chapterId*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

curl -X POST "https://example.com/chapters/497f6eca-6276-4993-bfeb-53cbbbba6f08/web-block" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {}
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}