API referenceProjects

Export the project as a HyperFrames folder

The project as a plain HyperFrames folder that upstream npx hyperframes render .

The project as a plain HyperFrames folder that upstream npx hyperframes render . plays: root index.html with every scene a sub-composition at its film window (the get_timeline tree), compositions/ (native scenes: the authored document; structured scenes: compiled output), captions/ (the captions layer), audio tracks, typecut.json. The zip is hosted and its url returned; format=zip returns the zip itself. Free.

POST
/projects/{id}/hyperframes/export

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

id*string
Formatuuid

Query Parameters

format?string
Value in"zip"
scenes?string

Comma-separated scene ids (at most 20): just those documents, inline and stamped as the folder holds them.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/hyperframes/export"
{
  "data": {}
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}