OpenFish Documentation

Appearance

Get annotations​

GET
/api/v1/annotations

Get paginated annotations, with options to filter by video stream.

Parameters​

Query Parameters

limit

Number of results to return.

Typeinteger
default20
minimum1
offset

Number of results to skip.

Typeinteger
minimum0
name

Name to filter by.

Typestring
videostream

Video stream to filter by.

Typeinteger

Responses​

OK
application/json
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"created_by": {
"display_name": "Coral Fischer",
"id": 1234567890,
"role": "annotator"
},
"duration": 15,
"end": "01:56:05.500",
"id": 1234567890,
"identifications": [
{
"identified_by": [
{
"display_name": "Coral Fischer",
"id": 1234567890,
"role": "annotator"
}
],
"species": {
"common_name": "Whale Shark",
"id": 1234567890,
"scientific_name": "Rhincodon typus"
}
}
],
"keypoints": [
{
"box": {
"x1": 10,
"x2": 50,
"y1": 25,
"y2": 75
},
"time": "01:56:05.500"
}
],
"start": "01:56:05.500",
"videostream": {
"id": 1234567890,
"stream_url": "https://www.youtube.com/watch?v=abcdefghijk"
}
}
],
"total": 1
}

Samples​