Docs
Log inStart free
API referenceProjects

Find shots of the project's reference

Shots whose on-screen text contains a string, or of a given kind / framing; or, with similar_to (a shot index), the nearest shots by picture (measure dino = composition and content, clip = meaning; cosine distance, smaller is closer).

Shots whose on-screen text contains a string, or of a given kind / framing; or, with similar_to (a shot index), the nearest shots by picture (measure dino = composition and content, clip = meaning; cosine distance, smaller is closer). Needs the shot embeddings (they are filled in the background). Free.

GET
/projects/{id}/reference/find

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

text?string
kind?string
framing?string
similar_to?|

A shot index of the reference: return the shots nearest to it.

Range0 <= value
measure?string
Value in"dino" | "clip"
scope?string

source (default) searches the reference alone; account searches every source you can read.

Value in"source" | "account"
limit?integer
Range1 <= value <= 50

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/reference/find"
{
  "data": {
    "measure": "string",
    "shots": [
      {
        "i": 0,
        "t0": 0,
        "t1": 0,
        "kind": "string",
        "framing": "string",
        "on_screen_text": "string",
        "graphics": true,
        "voice_over": true,
        "motion": null,
        "palette": null,
        "keyframe_url": "string",
        "source_id": "string",
        "distance": 0
      }
    ],
    "notes": [
      "string"
    ]
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}

What the project's reference says in a window GET

The reference's shots (kind, framing, on-screen text, motion, palette, keyframe url), its transcript and any sound events inside a window, as rows.

Compare a scene with the project's reference POST

Renders a few frames of the scene and takes the reference frames at the aligned times, then returns how far apart they look: a distance vector (DINO = composition and content, CLIP = meaning; cosine d