Skip to content

Get annotation by ID

GET
/api/v1/annotations/{id}

Gets an annotation when provided with an ID.

Parameters

Path Parameters

id*

Annotation ID

Typeinteger
Required
Example1234567890

Responses

OK
JSON
{
"id": 1234567890,
"keypoints": [
{
"box": {
"x1": 10,
"x2": 50,
"y1": 25,
"y2": 75
},
"time": "01:56:05.500"
}
],
"observation": {
"common_name": "Zebrafish",
"species": "Girella Zebra"
},
"observer": "user@example.com",
"videostreamId": 1234567890
}

Samples

cURL
curl -X GET https://openfish.appspot.com/api/v1/annotations/{id}
JavaScript
fetch("https://openfish.appspot.com/api/v1/annotations/{id}")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("https://openfish.appspot.com/api/v1/annotations/{id}");
Python
import requests
response = requests.get("https://openfish.appspot.com/api/v1/annotations/{id}")
print(response.json())