> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cloudglue.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Face Match Results

> Retrieve face match results including detected faces and similarity scores



## OpenAPI

````yaml GET /face-match/{face_match_id}
openapi: 3.0.0
info:
  title: Cloudglue API
  description: API for Cloudglue
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.7.9
servers:
  - url: https://api.cloudglue.dev/v1
security:
  - bearerAuth: []
paths:
  /face-match/{face_match_id}:
    get:
      tags:
        - Face Match
      summary: Get face match results
      description: >-
        Retrieve face match results including detected faces and similarity
        scores
      operationId: getFaceMatch
      parameters:
        - name: face_match_id
          in: path
          required: true
          description: The ID of the face match to retrieve
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          description: Number of face matches to return
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
        - name: offset
          in: query
          description: Offset from the start of the face matches list
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: Face match results retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceMatch'
        '404':
          description: Face match job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: An unexpected error occurred on the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    FaceMatch:
      type: object
      required:
        - face_match_id
        - status
        - created_at
      properties:
        face_match_id:
          type: string
          format: uuid
          description: Unique identifier for the face match job
        face_detection_id:
          type: string
          format: uuid
          description: ID of the face detection analysis used
        frame_extraction_id:
          type: string
          format: uuid
          description: ID of the frame extraction used
        file_id:
          type: string
          format: uuid
          description: ID of the target file
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          description: Status of the face match job
        created_at:
          type: number
          description: Unix timestamp in milliseconds when the job was created
        source_face_bounding_box:
          allOf:
            - $ref: '#/components/schemas/FaceBoundingBox'
          nullable: true
          description: >-
            Bounding box of the source face in the source image (null when job
            is pending/processing)
        data:
          type: object
          description: Face match results (only present when status is completed)
          properties:
            object:
              type: string
              enum:
                - list
              description: Object type, always 'list'
            total:
              type: integer
              description: Total number of face matches found
            limit:
              type: integer
              minimum: 1
              maximum: 100
              description: Number of face matches returned per page
            offset:
              type: integer
              minimum: 0
              description: Offset from the start of the face matches list
            faces_matches:
              type: array
              items:
                $ref: '#/components/schemas/FaceMatchResult'
              description: Array of face matches found
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    FaceBoundingBox:
      type: object
      required:
        - height
        - width
        - top
        - left
      properties:
        height:
          type: number
          minimum: 0
          maximum: 1
          description: Height of the bounding box (normalized 0-1)
        width:
          type: number
          minimum: 0
          maximum: 1
          description: Width of the bounding box (normalized 0-1)
        top:
          type: number
          minimum: 0
          maximum: 1
          description: Top position of the bounding box (normalized 0-1)
        left:
          type: number
          minimum: 0
          maximum: 1
          description: Left position of the bounding box (normalized 0-1)
    FaceMatchResult:
      type: object
      required:
        - id
        - face_bounding_box
        - similarity
        - frame_id
        - timestamp
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the face match result
        face_bounding_box:
          $ref: '#/components/schemas/FaceBoundingBox'
          description: Bounding box of the matched face in the frame
        similarity:
          type: number
          minimum: 0
          maximum: 100
          description: Similarity score between source face and detected face (0-100)
        frame_id:
          type: string
          format: uuid
          description: ID of the frame where the match was found
        timestamp:
          type: number
          description: Timestamp of the frame in seconds
        thumbnail_url:
          type: string
          description: URL of the frame thumbnail (if frame extraction enabled thumbnails)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````