Skip to main content
GET
/
api
/
v1
/
datasets
/
{dataset_id}
/
annotation-sets
/
{annotation_set_id}
/
annotations
List Annotations
curl --request GET \
  --url https://api.example.com/api/v1/datasets/{dataset_id}/annotation-sets/{annotation_set_id}/annotations \
  --header 'X-API-Key: <api-key>'
[
  {
    "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

Query Parameters

​
audio_file_id
string<uuid> | null
​
artifact_type
string | null

Response

Successful 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