Skip to main content
POST
Score moments

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

Body

application/json

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

transcript
object[]
required

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

Required array length: 1 - 20000 elements
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
assetId
string

Score a transcript this workspace has already had transcribed instead of sending one. Send exactly one of transcript or assetId. Asset ids come from GET /v1/assets (an asset is usable once transcriptReady is true). An asset you may not edit, one in another workspace and one not yet transcribed are all reported as not found.

Required string length: 1 - 200
channel
string

Plain-language channel voice or audience context.

Required string length: 1 - 120
niche
string

Subject area used when judging relevance.

Required string length: 1 - 200
thresholds
object

Optional score cutoffs. Omitted fields use the service defaults.

platforms
enum<string>[]

Target short-form surfaces. The strictest requested duration ceiling is enforced before any render is planned.

Required array length: 1 - 5 elements
Available options:
youtube,
tiktok,
instagram,
facebook,
snapchat
maxClips
integer

Maximum reviewed moments to return after deterministic refinement.

Required range: 1 <= x <= 20
overlapTolerance
number

Maximum overlap fraction of the shorter clip before the lower-ranked candidate is removed.

Required range: 0 <= x <= 1

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

moments
object[]
required

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

suppressedOverlaps
integer
required

Lower-ranked candidates removed after deterministic range refinement.

Required range: 0 <= x <= 9007199254740991
quality
object
required

Versioned selection evidence, including duration profile, fallback state, and review requirement.

transcriptMinutes
number
required

What was billed: minutes of transcript scored.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

reused
object

Present only when assetId was sent: the indexed transcript this call scored, how many cues, and when it was captured.

{key}
any