API referenceProjects

Import a HyperFrames folder

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

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 zip as the body (application/zip, ?dry_run=1&force=1). Only documents that differ from the current ones land, through put_scene_composition; a root sub-composition with no scene becomes a new scene (its data-chapter, else the last chapter). A document exported from an older version of its scene is refused unless force. Landing is free; a composition that expands asset slots may spend.

POST
/projects/{id}/hyperframes/import

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

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/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/hyperframes/import" \  -H "Content-Type: application/json" \  -d '{    "files": [      {        "path": "string"      }    ]  }'
{
  "data": {}
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}