Skip to main content
POST
/
api
/
v1
/
datasets
/
{dataset_id}
/
annotation-sets
/
{annotation_set_id}
/
annotations
Create Annotation
curl --request POST \
  --url https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "artifact_type": "<string>",
  "start_ms": 1,
  "end_ms": 123,
  "confidence": 1,
  "extra_data": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "annotation_set_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "audio_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "artifact_type": "<string>",
  "start_ms": 123,
  "end_ms": 123,
  "confidence": 123,
  "extra_data": {},
  "created_at": "2023-11-07T05:31:56Z"
}

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

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