Timelines

Get project timeline

Returns the project's current active timeline as a Kaitoi Timeline Document v1. This is a read-only export of timeline state.

get/api/v1/projects/{project_id}/timeline

Request

Base URL: https://api.studio.kaitoi.io (the document declares no server; this is the origin it was published from)
URL: https://api.studio.kaitoi.io/api/v1/projects/{project_id}/timeline
Auth: HTTP bearer

Path parameters

project_idstring required

Headers

authorizationstring nullable

Response

Project timeline document.

projectIdstring required

Stable project identifier.

versioninteger required

Optimistic concurrency version for the project.

documentobject required

Project timeline exported as Kaitoi Timeline Document v1.

Example response

{
  "document": {
    "kaitoiType": "timeline",
    "name": "Timeline",
    "timeline": {
      "clips": [
        {
          "duration": 3,
          "filename": "hero.png",
          "id": "clip-1",
          "name": "Hero",
          "opacity": 100,
          "startTime": 0,
          "storageType": "data",
          "trackId": "track-1",
          "transform": {
            "rotation": 0,
            "scale": 100,
            "x": 0,
            "y": 0
          },
          "trimEnd": 0,
          "trimStart": 0,
          "type": "image",
          "volume": 100
        }
      ],
      "currentTime": 0,
      "frameRate": 30,
      "playheadPosition": 0,
      "projectDuration": 60,
      "projectResolution": {
        "height": 1080,
        "isAutoDetected": true,
        "width": 1920
      },
      "selectedClipIds": [],
      "selectedTrackId": "track-1",
      "tracks": [
        {
          "height": 60,
          "id": "track-1",
          "locked": false,
          "mutedAudio": false,
          "mutedVideo": false,
          "name": "Track 1",
          "volume": 1
        }
      ],
      "zoom": 100
    },
    "version": 1
  },
  "projectId": "proj_123",
  "summary": {
    "clipCount": 1,
    "durationSeconds": 60,
    "trackCount": 1
  },
  "version": 7
}

Changes

No recorded changes to this operation across all 1 revision of this API.