API referenceScenes

Export a scene as an embeddable web block

Publish a finished, resolved DOM+GSAP scene as a block any web page can embed and drive.

You declare the contract in manifest (typed inputs, named timeline states, events, text/colour slots); a validation gate refuses a scene that is not portable or a manifest that does not match it, with a fix for every error. Returns a hosted embed_url and the two-line snippet (a data-typecut-block div plus the loader script). Re-exporting a scene keeps its embed_url and bumps the version. dry_run runs the gate only. Free.

POST
/scenes/{sceneId}/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

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

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