Skip to main content
POST
Create Annotation

Authorizations

X-API-Key
string
header
required

Path Parameters

dataset_id
string<uuid>
required
annotation_set_id
string<uuid>
required

Body

application/json

Request to create an annotation.

audio_file_id
string<uuid>
required
artifact_type
string
required
Required string length: 1 - 100
start_ms
integer
required
Required range: x >= 0
end_ms
integer
required
confidence
number
default:1
Required range: 0 <= x <= 1
extra_data
Extra Data · object | null

Response

Successful Response

Annotation response.

id
string<uuid>
required
annotation_set_id
string<uuid>
required
audio_file_id
string<uuid>
required
artifact_type
string
required
start_ms
integer
required
end_ms
integer
required
confidence
number
required
extra_data
Extra Data · object
required
created_at
string<date-time>
required