Get Face Match Results

Get face match results

curl --request GET \
  --url https://api.cloudglue.dev/v1/face-match/{face_match_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloudglue.dev/v1/face-match/{face_match_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudglue.dev/v1/face-match/{face_match_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudglue.dev/v1/face-match/{face_match_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cloudglue.dev/v1/face-match/{face_match_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "face_match_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
  },
  "data": {
    "object": "list",
    "total": 123,
    "limit": 50,
    "offset": 1,
    "faces_matches": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "face_bounding_box": {
          "height": 0.5,
          "width": 0.5,
          "top": 0.5,
          "left": 0.5
        },
        "similarity": 50,
        "frame_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timestamp": 123,
        "thumbnail_url": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

face-match

{face_match_id}

Get face match results

curl --request GET \
  --url https://api.cloudglue.dev/v1/face-match/{face_match_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cloudglue.dev/v1/face-match/{face_match_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cloudglue.dev/v1/face-match/{face_match_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudglue.dev/v1/face-match/{face_match_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.cloudglue.dev/v1/face-match/{face_match_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "face_match_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
  },
  "data": {
    "object": "list",
    "total": 123,
    "limit": 50,
    "offset": 1,
    "faces_matches": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "face_bounding_box": {
          "height": 0.5,
          "width": 0.5,
          "top": 0.5,
          "left": 0.5
        },
        "similarity": 50,
        "frame_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "timestamp": 123,
        "thumbnail_url": "<string>"
      }
    ]
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

face_match_id

string<uuid>

required

The ID of the face match to retrieve

Query Parameters

limit

integer

Number of face matches to return

Required range: 1 <= x <= 100

offset

integer

Offset from the start of the face matches list

Required range: x >= 0

Response

Face match results retrieved successfully

face_match_id

string<uuid>

required

Unique identifier for the face match job

status

enum<string>

required

Status of the face match job

Available options:

pending,

processing,

completed,

failed

created_at

number

required

Unix timestamp in milliseconds when the job was created

face_detection_id

string<uuid>

ID of the face detection analysis used

frame_extraction_id

string<uuid>

ID of the frame extraction used

file_id

string<uuid>

ID of the target file

source_face_bounding_box

object | null

Bounding box of the source face in the source image (null when job is pending/processing)

Show child attributes

data

object

Face match results (only present when status is completed)

Show child attributes

Using the API

Files

Extract

Describe

Segments

Find Moments

Common Collection Operations

Response

Deep Search

Query

Search

Chat

Media Description Collection

Entity Collection

Face Analysis Collection

Moments Collection

Thumbnails

Segmentation

File Segments

Frames

Face Match

Face Detection

Share

Sites

Tags

Data Connectors

Bulk Imports

Webhooks

Transcribe (Legacy)

Rich Transcripts Collection (Legacy)

Get Face Match Results

Authorizations

Path Parameters

Query Parameters

Response