face_detection_retrieve_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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id of the task. This value is returned by the [face detection API](https://docs.magichour.ai/api-reference/files/face-detection#response-id). | |
| context | No | Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution." |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The id of the task. This value is returned by the [face detection API](https://docs.magichour.ai/api-reference/files/face-detection#response-id). | |
| faces | Yes | The faces detected in the image or video. The list is populated as faces are detected. | |
| status | Yes | The status of the detection. | |
| credits_charged | Yes | The credits charged for the task. |