Skip to main content
POST
Create Annotation

Body

application/json

Request body for POST /v1/annotations.

Clients name an annotator (an instrument in the registry), never a model or provider. options is an open bag for per-request knobs.

annotator
string
required
transcript
TranscriptMessage · object[]
required
options
Options · object

Response

Successful Response

Response body for POST /v1/annotations.

annotator
string
required
annotator_version
string
required
outcome
enum<string>
required
Available options:
strong,
mixed,
poor,
critical,
indeterminate
outcome_notes
string
required
signals
Signals · object
required
summary
AnnotationSummary · object
required

Structured summary of the conversation under annotation.

taxonomy_version
string
required
usage
UsageInfo · object
required

Token/latency accounting for one annotation call.