Get Face Detection Details API Reference - Magic Hour Docs

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}

Python

Python

from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.face_detection.get(id="uuid-example")

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Path Parameters

id · string · required

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

Example:

"uuid-example"

Response

200

application/json

200

id · string · required

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

Example:

"uuid-example"

credits_charged · integer · required

The credits charged for the task.

Example:

0

status · enum<string> · required

The status of the detection.

Available options: queued, rendering, complete, error

Example:

"complete"

faces · object[] · required

The faces detected in the image or video. The list is populated as faces are detected.

Show child attributes

Example:

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