Docs
Log inStart free
API referenceProjects

Wait for the project to move (synced-folder long-poll)

Each live scene's composition_version and the project's structure_version, with a cursor fingerprinting them.

Pass the last cursor and wait (seconds, at most 25) to be held until an editor save, edit_elements or a changeset moves something; changed: false when the wait ran out. Re-export the scenes whose version moved (hyperframes/export?scenes=). What typecut dev uses to pull a human's edits back to disk. Free.

GET
/projects/{id}/hyperframes/watch

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

cursor?string
wait?|
Range0 <= value <= 25

Response Body

application/json

application/json

application/json

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

Export the project as a HyperFrames folder POST

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

Import a HyperFrames folder POST

An edited HyperFrames folder back into the project, as JSON {files: [{path, content | src_url}], dry_run, force} (src_url: a create_upload public_url, for documents too large to send inline) or the zi