Skip to main content
GET
/
collections
/
{collection_id}
/
videos
/
{file_id}
/
face-detections
Retrieve face detections for a specific file in a collection
curl --request GET \
  --url https://api.cloudglue.dev/v1/collections/{collection_id}/videos/{file_id}/face-detections \
  --header 'Authorization: Bearer <token>'
{
  "collection_id": "<string>",
  "file_id": "<string>",
  "faces": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "face_bounding_box": {
        "height": 0.5,
        "width": 0.5,
        "top": 0.5,
        "left": 0.5
      },
      "frame_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": 1,
      "thumbnail_url": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
For details on how to create a face-analysis collection, see Create Collection

Authorizations

Authorization
string
header
required

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

Path Parameters

collection_id
string
required

The ID of the collection

file_id
string
required

The ID of the file

Query Parameters

limit
integer
default:50

Maximum number of faces to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of faces to skip

Required range: x >= 0

Response

File face detections

collection_id
string
required

ID of the collection

file_id
string
required

ID of the file

faces
object[]
required

Array of detected faces

total
integer
required

Total number of faces detected

limit
integer
required

Maximum number of faces returned per request

offset
integer
required

Number of faces skipped