v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB
Files

Get face detection details

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}

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"
    }
  ]
}