MAmagichourhq
Files

Get face detection details

Changed on

Get the details of a face detection task.

Use this API to get the list of faces detected in the image or video to use in the face swap photo or face swap video API calls for multi-face swaps.

get/v1/face-detection/{id}

Request

  • Base URL
    https://api.magichour.ai
  • URL
    https://api.magichour.ai/v1/face-detection/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:uuid-example

The id of the task. This value is returned by the face detection API.

Response

200

idstring required

The id of the task. This value is returned by the face detection API.

credits_chargedinteger required

The credits charged for the task.

status'queued' | 'rendering' | 'complete' | 'error' required

The status of the detection.

Example response

{
  "id": "uuid-example",
  "status": "complete",
  "faces": [
    {
      "path": "api-assets/id/0-0.png",
      "url": "https://videos.magichour.ai/api-assets/id/0-0.png"
    }
  ]
}

Changes

  • 9aeb9397c62aRevision changes
    • info

      added the non-success response with the status

    • info

      removed the Not Found enum value from the response property for the response status

    • info

      removed the Unauthorized enum value from the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 1f72d520ddc6Revision changes
    • info

      added the non-success response with the status