OpenFish Documentation

Appearance

Create annotation​

POST
/api/v1/annotations

Roles required: Annotator, Curator or Admin

Creates a new annotation from provided JSON body.

Request Body​

JSON
{
"identification": 1234567890,
"keypoints": [
{
"box": {
"x1": 10,
"x2": 50,
"y1": 25,
"y2": 75
},
"time": "01:56:05.500"
}
],
"videostream_id": 1234567890
}

Responses​

Created
application/json
JSON
{
"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"
}
}

Samples​