Skip to content

fix: update api documentation links and descriptions #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidhu2000 merged 1 commit into from
Mar 9, 2026
Merged

fix: update api documentation links and descriptions #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"id": "1e4b45ec-8087-484b-a717-95683600de86",
"id": "79b6b8f9-cd15-4aec-ac0f-cd16313a0353",
"tracked_paths": [
{
"editable": true,
Expand Down
2 changes: 1 addition & 1 deletion magic_hour/environment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ class Environment(enum.Enum):
"""Pre-defined base URLs for the API"""

ENVIRONMENT = "https://api.magichour.ai"
MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.54.0"
MOCK_SERVER = "https://api.sideko.dev/v1/mock/magichour/magic-hour/0.55.1"


def _get_base_url(
Expand Down
2 changes: 1 addition & 1 deletion magic_hour/resources/v1/ai_voice_generator/README.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions magic_hour/resources/v1/face_detection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ res = await client.v1.face_detection.generate(

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](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/image-projects/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/video-projects/face-swap-video) API calls for multi-face swaps.

**API Endpoint**: `GET /v1/face-detection/{id}`

#### Parameters

| Parameter | Required | Description | Example |
| --------- | :------: | ------------------------------------------------------------------------------------------------------------------------ | ---------------- |
| `id` | ✓ | The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id). | `"uuid-example"` |
| Parameter | Required | Description | Example |
| --------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
| `id` | ✓ | 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). | `"uuid-example"` |

#### Synchronous Client

Expand Down Expand Up @@ -106,7 +106,7 @@ res = await client.v1.face_detection.get(id="uuid-example")

Detect faces in an image or video.

Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/face-swap-photo/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.

Note: Face detection is free to use for the near future. Pricing may change in the future.

Expand Down
12 changes: 6 additions & 6 deletions magic_hour/resources/v1/face_detection/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,12 @@ def get(

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](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/image-projects/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/video-projects/face-swap-video) API calls for multi-face swaps.

GET /v1/face-detection/{id}

Args:
id: The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
id: 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).
request_options: Additional options to customize the HTTP request

Returns:
Expand Down Expand Up @@ -164,7 +164,7 @@ def create(

Detect faces in an image or video.

Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/face-swap-photo/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.

Note: Face detection is free to use for the near future. Pricing may change in the future.

Expand Down Expand Up @@ -297,12 +297,12 @@ async def get(

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](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/image-projects/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/video-projects/face-swap-video) API calls for multi-face swaps.

GET /v1/face-detection/{id}

Args:
id: The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
id: 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).
request_options: Additional options to customize the HTTP request

Returns:
Expand Down Expand Up @@ -339,7 +339,7 @@ async def create(

Detect faces in an image or video.

Use this API to get the list of faces detected in the image or video to use in the [face swap photo](/api-reference/face-swap-photo/face-swap-photo) or [face swap video](/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.
Use this API to get the list of faces detected in the image or video to use in the [face swap photo](https://docs.magichour.ai/api-reference/face-swap-photo/face-swap-photo) or [face swap video](https://docs.magichour.ai/api-reference/face-swap/face-swap-video) API calls for multi-face swaps.

Note: Face detection is free to use for the near future. Pricing may change in the future.

Expand Down
2 changes: 1 addition & 1 deletion magic_hour/types/models/v1_face_detection_create_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ class V1FaceDetectionCreateResponse(pydantic.BaseModel):
alias="id",
)
"""
The id of the task. Use this value in the [get face detection details API](/api-reference/files/get-face-detection-details) to get the details of the face detection task.
The id of the task. Use this value in the [get face detection details API](https://docs.magichour.ai/api-reference/files/get-face-detection-details) to get the details of the face detection task.
"""
2 changes: 1 addition & 1 deletion magic_hour/types/models/v1_face_detection_get_response.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class V1FaceDetectionGetResponse(pydantic.BaseModel):
alias="id",
)
"""
The id of the task. This value is returned by the [face detection API](/api-reference/files/face-detection#response-id).
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).
"""
status: typing_extensions.Literal["complete", "error", "queued", "rendering"] = (
pydantic.Field(
Expand Down
2 changes: 1 addition & 1 deletion magic_hour/types/params/v1_ai_voice_generator_create_body_style.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ class V1AiVoiceGeneratorCreateBodyStyle(typing_extensions.TypedDict):

prompt: typing_extensions.Required[str]
"""
Text used to generate speech. Starter tier users can use up to 1000 characters, while Creator, Pro, or Business users can use up to 1000.
Text used to generate speech. The character limit is 1000 characters.
"""

voice_name: typing_extensions.Required[
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "magic_hour"
version = "0.55.0"
version = "0.55.1"
description = "Python SDK for Magic Hour API"
readme = "README.md"
authors = []
Expand Down