Docs
Log inStart free
API referenceProjects

Record the source a project is meant to match

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

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 the source ([{scene_id, ref_t0, ref_t1}] in seconds; absent = proportional). The body replaces the whole reference; both ids null clears it. expected_version makes it a compare-and-set. Pictures of it: GET /projects/{id}/reference/frames.

PUT
/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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/reference" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "reference": {
      "property1": null,
      "property2": null
    },
    "analysis": {
      "property1": null,
      "property2": null
    },
    "audio_analysis": {
      "property1": null,
      "property2": null
    },
    "edit_version": 0
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "conflict",
    "code": "conflict",
    "message": "string",
    "current_version": 0,
    "expected_version": 0,
    "last_writer": {
      "label": "string",
      "kind": "editor",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
      "at": "string"
    }
  }
}

The source a project is meant to match GET

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

A picture of the project's reference at any time, width and crop GET

Same as GET /video-analyses/{analysisId}/frames, resolved through the project's reference (404 when it has none).