Get Video Face Image Url Route

GET 
/v2/videos/{video_id}/faces/{face_id}/image-url

Get a short-lived URL for a face's image.

The returned url serves the stored image of one detected face, ready to use as an image source. It is short-lived: request a new one when expires_at passes or when a request made with it is refused, and do not store or share it. A face's image field in the video details is a stored reference, not guaranteed to be readable; this endpoint is how to show it.

Access Control: the same as the video details. The owner and admins can always get a face image URL. While a video is shared, or is a sample, anyone can, so sharing a video lets anyone with its link see its faces.

Errors:

• 401: not authorized to access this video
• 404: video or face not found
• 409 media_not_stored: the face has no stored image (for example, a face added manually, or one whose image is not ready yet), or its image could not be looked up just now; retrying may succeed
• 503 media_storage_unavailable: the URL could not be issued; try again shortly

Request

Responses

200

Successful Response

401

Missing, malformed or rejected credentials — no X-API-Key / Authorization: Bearer <jwt>, an expired token, or a caller that lacks the role the route requires. Note that this API answers authorization failures with 401 as well as 403 (see the 403 entry where a route declares both).

404

No such resource, or it is not visible to this caller. Ownership failures are reported as 404 rather than 403 so the API does not confirm the existence of another account's records.

409

media_not_stored: this face has no stored image yet, or its image could not be looked up just now. Retrying may succeed.

422

Validation Error

503

media_storage_unavailable: try again shortly.