Skip to navigation
Images

List annotations on an image

View as Markdown

List the masks saved on an image, oldest first.

Each annotation has a label, an is_human_vetted flag, and a signed mask_url for the binary mask PNG. Signed URLs expire, so download masks soon after listing them. Results include unvetted masks from automated saves. Only human-vetted masks feed training. The file must be a processed image.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

file_idstringRequired

Response

OK
idstringformat: "uuid"
labelstring
mask_urlstring or nullOptional
widthinteger or nullOptional
heightinteger or nullOptional
is_human_vettedbooleanOptionalDefaults to false
foreground_fractiondouble or nullOptional
bboxobject or nullOptional
Bounding box of a mask's visible pixels, in mask pixel coordinates.
userobject or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error