API referenceProjects

Hear a stretch of the film (the mix, measured)

The export's own mix of a window on the film clock (at most 120 s), rendered whole and per group — dialogue (narration + scene speech), music (cues and beds), effects (SFX + scene sounds) — and measur

ed: short-term LUFS every 0.5 s per group, integrated loudness and true peak against -14 LUFS / -1 dBTP, sounds more than outlier_db (default 6) above their surroundings named by cue / sound / scene, music or effects within mask_db (default 6) of the voice in 1-2 / 2-4 kHz while it speaks, the voice-over-bed ratio, and verdicts in words. bounce: true also hosts an m4a of the window. Free.

POST
/projects/{id}/listen

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

curl -X POST "https://example.com/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/listen" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "from": 0,
    "to": 0,
    "film_sec": 0,
    "loudness": [
      {
        "t": 0,
        "full": 0,
        "dialogue": 0,
        "music": 0,
        "effects": 0
      }
    ],
    "delivery": {
      "integrated_lufs": 0,
      "true_peak_dbtp": 0,
      "ok": true,
      "verdict": "string"
    },
    "outliers": [
      {
        "film_t": 0,
        "excess_db": 0,
        "label": "string",
        "group": "string",
        "ref": "string",
        "scene_id": "string"
      }
    ],
    "masking": {
      "dialogue_to_bed_db": 0,
      "dialogue_sec": 0,
      "spans": [
        {
          "film_from": 0,
          "film_to": 0,
          "margin_db": 0,
          "band": "string",
          "culprit": "string"
        }
      ]
    },
    "verdicts": [
      "string"
    ],
    "bounce_url": "string",
    "notes": [
      "string"
    ]
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}
{
  "error": {
    "type": "string",
    "code": "string",
    "message": "string"
  }
}