Skip to main content
POST
Score moments

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json

Send exactly one source: either transcript or assetId, not both and not neither.

transcript
object[]

The segments to score. Send exactly one of transcript or assetId.

Required array length: 1 - 20000 elements
assetId
string

Score a transcript this workspace has already had transcribed instead of sending one. Send exactly one of transcript or assetId. An asset in another workspace is reported as not found.

Required string length: 1 - 200
channel
string
Required string length: 1 - 120
niche
string
Required string length: 1 - 200
thresholds
object
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

moments
any[]
required

The spans worth cutting, scored. Each carries its start, end and why it scored.

transcriptMinutes
number
required

What was billed: minutes of transcript scored.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any