Docs
Log inStart free
API referenceProjects

The source a project is meant to match

The video analysis recorded as the project's reference, with its state (status, duration, shots, size).

reference: null when none is set.

GET
/projects/{id}/reference

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/reference"
{
  "data": {
    "reference": {
      "analysis_id": "6ad457ea-9426-4897-bff8-c6f3fe690582",
      "audio_analysis_id": "3ee920c7-a1ec-481f-b65d-8394ed1533ed",
      "alignment": [
        {
          "scene_id": "861eef56-1159-4a95-802f-abab2d0cc192",
          "ref_t0": 0,
          "ref_t1": 0
        }
      ],
      "role": "reference",
      "note": "string",
      "updated_at": "string"
    },
    "analysis": {
      "property1": null,
      "property2": null
    },
    "audio_analysis": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

Declare the shared modules a project (or chapter) runs on PUT

Module refs "id@version" in load order; chapter_id sets one chapter's own list; modules: null clears.

Record the source a project is meant to match PUT

Points the project at a video analysis (analysis_id, analyze_video first) and/or an audio analysis (audio_analysis_id, analyze_audio first), with an optional alignment of replica scenes to spans of th