Skip to content
OnCoreDocs
Transcriber Tests

PUThttps://core-api.heysadie.ai/transcriber-banks/{id}/candidates

id windowDays transcriberIds backfill success data bank organizationId name languageLabel threshold controlLinesPerFlag candidates createdBy createdAt updatedAt turns audioSeconds estimatedCostUsd jobIds metadata timestamp version path error code message details field limit

Replace a bank's candidates

Replace the candidates, in display order, and optionally backfill them over past turns. - Call POST /transcriber-banks/:id/candidates/estimate first to show the cost while candidates are being picked. - The backfill covers each flagged or control turn of the last `windowDays` and each candidate with no attempt on it and no job already running it, so repeating the call queues nothing twice. - `backfill: true` queues those pairs (`backfill.jobIds`); `false` saves the list only. Either way the response carries the estimate. - A candidate otherwise replays only turns that join the bank while it is a candidate; the backfill is how it covers older ones. - A removed candidate's attempts are kept but no longer scored. Errors: 404 RESOURCE_NOT_FOUND when the bank is not in the organization or a transcriber id has no live catalogue row (`details.transcriberIds`). 422 BANK_LIMIT when more than 8 ids are sent. 429 BACKLOG_FULL when `backfill` is true and the organization already has more than 50 jobs waiting; nothing is written, so retry later or save with `backfill: false`.

Try it in the API Explorer

Example request

Terminal
curl -X PUT "https://core-api.heysadie.ai/transcriber-banks/TRANSCRIBER_BANK_ID/candidates" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "transcriberIds": [
      "0199a1b2-aaaa-7bbb-8ccc-0000000000a1",
      "0199a1b2-aaaa-7bbb-8ccc-0000000000a3"
    ],
    "backfill": true
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme. See Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

A live bank of the organization

Query parameters

windowDaysstringoptional

Days back from now, by turn creation, the backfill covers. 1 to 90, default 30

Body application/json · required

transcriberIdsstring[]required

Transcriber ids to test, in display order. Distinct, from GET /transcribers. More than 8 is a 422 BANK_LIMIT; an id with no live catalogue row is a 404 naming it in `details.transcriberIds`

backfillbooleanrequired

true queues the missing (turn, candidate) pairs in the window; false saves the list without queuing them. Either way the list is replaced and the backfill estimated

Responses

200The bank with its new candidates, and the backfill
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 2 child properties
bankobjectrequired

A named set of candidate transcribers, e.g. one per language, tested on the flagged and control turns that join it

Show 10 child properties
idstringrequired

Bank id

organizationIdstringrequired

The organization that owns the bank

namestringrequired

Unique among the organization's banks, ignoring case, e.g. "English"

languageLabelstringrequired

Display only, e.g. "en-US" or "en + fr"

thresholdnumberrequired

Accuracy, 0 to 1, a candidate must reach to clear the bank. `leader.clearsThreshold` compares against it

controlLinesPerFlagenumrequired

Unflagged caller lines of the same call sampled as controls with each flag created in the bank (POST /turn-flags with `bankId`; a flag moved in later gets none): 0, 1 or 2. A control's expected text is the live transcriber's own text, so controls show what a candidate breaks on lines production got right

Allowed values:012
candidatesobject[]required

The transcribers under test, in display order, at most 8. A candidate replays the flagged and control turns that join the bank while it is a candidate; older turns only through a backfill (PUT /transcriber-banks/:id/candidates with `backfill: true`) within its window

Show 2 item properties
idstringrequired

Transcriber id, as GET /transcribers lists it

namestringrequired

The transcriber's display name

createdBystring | nullrequired

Who made it, as the creating request named them in an `X-On-Behalf-Of` header. Null when it sent none

createdAtstring (date-time) | string (date) | number | nullrequired

When it was created, UTC

updatedAtstring (date-time) | string (date) | number | nullrequired

When it last changed, UTC

backfillobjectrequired

The window's missing (turn, candidate) pairs under the new list, and the jobs queued for them

Show 4 child properties
turnsstring (integer) | integerrequired

Flagged and control turns of the window missing at least one candidate's attempt, with no job already running it

audioSecondsnumberrequired

Seconds of audio over every missing (turn, candidate) pair: each clip with its 0.75 s margins and the trailing silence the vendor bills

estimatedCostUsdnumberrequired

Estimated STT cost in USD, 6 decimals, at each candidate's catalogue rate

jobIdsstring[]required

Queued backfill jobs. Empty when `backfill` was false or nothing was missing

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400VALIDATION_ERROR: a path id, query parameter or body field broke a rule; `details` lists each `field` and its `message`. A body with a missing field or a JSON type the schema does not allow answers 400 with code INTERNAL_SERVER_ERROR and no `details` instead, so branch on the status
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401UNAUTHORIZED: no valid credentials, or a dashboard token that names no organization. Send `Authorization: ApiKey <organization API key>`
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403ORG_SCOPE_REQUIRED: transcriber testing is an organization feature. Use an organization API key without `X-Tenant-Id`, or a dashboard token scoped to the organization. A tenant API key, an organization key sent with `X-Tenant-Id` for one of its tenants, or a token carrying a tenant gets this 403. FORBIDDEN: an organization key sent `X-Tenant-Id` for a tenant outside its organization
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

ORG_SCOPE_REQUIRED: the credentials carry a tenant scope. FORBIDDEN: an organization key sent `X-Tenant-Id` for a tenant outside its organization

Allowed values:"ORG_SCOPE_REQUIRED""FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404RESOURCE_NOT_FOUND: the bank is not in the organization, or a transcriber id has no live catalogue row (`details.transcriberIds` lists them)
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

The bank, or a transcriber asked for, does not exist

Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobjectoptional

Present when transcriber ids are the cause

Show 1 child properties
transcriberIdsstring[]required

Ids with no live catalogue row

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

422BANK_LIMIT: a bank tests at most 8 candidates (`details.limit`)
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

Too many candidates

Allowed values:"BANK_LIMIT"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobjectrequired

The limit hit

Show 1 child properties
limitstring (integer) | integerrequired

The most candidates a bank holds

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

429BACKLOG_FULL: the organization has more than `details.limit` (50) transcriber jobs waiting. Nothing was written; retry once some finish
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

Too many jobs waiting

Allowed values:"BACKLOG_FULL"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobjectrequired

The limit hit

Show 1 child properties
limitstring (integer) | integerrequired

Pending jobs the organization may hold

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested