Skip to content
OnCoreDocs
Transcriber Tests

POSThttps://core-api.heysadie.ai/transcriber-banks

name languageLabel threshold controlLinesPerFlag candidateIds success data bank id organizationId candidates createdBy createdAt updatedAt metadata timestamp version path error code message details field transcriberIds limit

Create a bank

Create a bank: a named set of up to 8 candidate transcribers, for example one bank per language. Pick candidates from GET /transcribers. It starts with no turns. A flag joins it when created with its `bankId`, or moved to it with PATCH /turn-flags/:id. Errors: 404 RESOURCE_NOT_FOUND when a candidate id has no live catalogue row (`details.transcriberIds`). 409 BANK_NAME_EXISTS when the organization already has a bank of that name, ignoring case. 422 BANK_LIMIT when more than 8 candidates are sent.

Try it in the API Explorer

Example request

Terminal
curl -X POST "https://core-api.heysadie.ai/transcriber-banks" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "English",
    "languageLabel": "en-US",
    "threshold": 0.6,
    "controlLinesPerFlag": 1,
    "candidateIds": [
      "0199a1b2-aaaa-7bbb-8ccc-0000000000a1",
      "0199a1b2-aaaa-7bbb-8ccc-0000000000a2"
    ]
  }'

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

Body application/json · required

namestringrequired

1 to 120 characters. Unique, ignoring case, among the organization's banks

languageLabelstringrequired

Display only, 1 to 60 characters, e.g. "en-US" or "en + fr"

thresholdnumberoptional

Accuracy, 0 to 1, a candidate must reach to clear the bank. Defaults to 0.6

controlLinesPerFlagstring (integer) | integeroptional

Unflagged caller lines of the same call sampled as controls with each flag created in the bank (not with flags moved in later): 0, 1 or 2. Defaults to 1

candidateIdsstring[]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`

Responses

201Created: the bank
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 1 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

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

409BANK_NAME_EXISTS: the organization already has a bank with this name, ignoring case
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

The name is taken

Allowed values:"BANK_NAME_EXISTS"
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

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

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