Skip to main content
GET
/
v1
/
face-detection
/
{id}
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")
{
  "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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.magichour.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

​
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.

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