Skip to main content
GET
/
face-match
List face match jobs
curl --request GET \
  --url https://api.cloudglue.dev/v1/face-match \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "total": 123,
  "limit": 123,
  "offset": 123,
  "data": [
    {
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "created_at": 123,
      "face_detection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "frame_extraction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_face_bounding_box": {
        "height": 0.5,
        "width": 0.5,
        "top": 0.5,
        "left": 0.5
      },
      "match_count": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:50

Number of face match jobs to return

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

Offset from the start of the face match jobs list

Required range: x >= 0
​
created_before
string<date>

Filter face match jobs created before a specific date (YYYY-MM-DD format), in UTC timezone

​
created_after
string<date>

Filter face match jobs created after a specific date (YYYY-MM-DD format), in UTC timezone

​
status
enum<string>

Filter by status

Available options:
pending,
processing,
completed,
failed

Response

200 - application/json

Face match jobs retrieved successfully

​
object
enum<string>
required

Object type, always 'list'

Available options:
list
​
total
integer
required

The total number of items

​
limit
integer
required

The number of items per page

​
offset
integer
required

The offset of the items

​
data
object[]