Skip to content

Regenerate model API reference docs #115

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

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Regenerate model API reference docs #115

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
7 changes: 7 additions & 0 deletions inference-api/reference/model-references.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Every model exposed by the Oxen.AI inference API has a dedicated reference page
- [WAN 2.7 - Reference to Video](/inference-api/reference/models/wan-v2-7-reference-to-video)
- [WAN 2.7 - Text to Video](/inference-api/reference/models/wan-v2-7-text-to-video)
- [WAN 3.0](/inference-api/reference/models/wan-v3-0-video)
- [WAN 3.0 Prime](/inference-api/reference/models/wan-v3-0-video-prime)

## Anthropic

Expand All @@ -55,7 +56,9 @@ Every model exposed by the Oxen.AI inference API has a dedicated reference page
- [FLUX.2 [flex]](/inference-api/reference/models/flux-2-flex)
- [FLUX.2 [pro]](/inference-api/reference/models/flux-2-pro)
- [FLUX 3 Video](/inference-api/reference/models/flux-3-video)
- [FLUX Image Upscaler](/inference-api/reference/models/flux-image-upscaler)
- [FLUX.1-Kontext [dev]](/inference-api/reference/models/flux-kontext-dev)
- [FLUX Video Upscaler](/inference-api/reference/models/flux-video-upscaler)

## ByteDance

Expand Down Expand Up @@ -117,6 +120,7 @@ Every model exposed by the Oxen.AI inference API has a dedicated reference page

## Krea

- [Krea 2 Raw](/inference-api/reference/models/krea-2-raw)
- [Krea 2 Large](/inference-api/reference/models/krea-v2-large-text-to-image)

## Lightricks
Expand Down Expand Up @@ -220,13 +224,15 @@ Every model exposed by the Oxen.AI inference API has a dedicated reference page
- [Topaz Astra 2](/inference-api/reference/models/topazlabs-astra-2-video)
- [Topaz Bloom 2](/inference-api/reference/models/topazlabs-bloom-2-image)
- [Topaz Bloom](/inference-api/reference/models/topazlabs-bloom-image)
- [Topaz Hyperion 2.5](/inference-api/reference/models/topazlabs-hyperion-2-5-video)
- [Topaz Hyperion 2](/inference-api/reference/models/topazlabs-hyperion-2-video)
- [Topaz Hyperion HDR](/inference-api/reference/models/topazlabs-hyperion-hdr-video)
- [Topaz Image Upscaler](/inference-api/reference/models/topazlabs-image-upscale)
- [Topaz Iris - Face Detail Video Upscaler](/inference-api/reference/models/topazlabs-iris-mq-video)
- [Topaz Proteus - Versatile Video Upscaler](/inference-api/reference/models/topazlabs-proteus-video)
- [Topaz Rhea - Fine Detail Video Upscaler](/inference-api/reference/models/topazlabs-rhea-video)
- [Topaz Starlight Precise 2.5](/inference-api/reference/models/topazlabs-upscale-starlight-2-5-video)
- [Topaz Starlight Precise 2.6](/inference-api/reference/models/topazlabs-upscale-starlight-2-6-video)
- [Topaz Video Upscaler](/inference-api/reference/models/topazlabs-video-upscale)
- [Topaz Wonder 3.5](/inference-api/reference/models/topazlabs-wonder-3-5-image)
- [Topaz Wonder 3](/inference-api/reference/models/topazlabs-wonder-3-image)
Expand All @@ -242,3 +248,4 @@ Every model exposed by the Oxen.AI inference API has a dedicated reference page
## Z AI

- [GLM 5.2](/inference-api/reference/models/zai-org-glm-5-2)
- [GLM 5.3](/inference-api/reference/models/zai-org-glm-5-3)
2 changes: 1 addition & 1 deletion inference-api/reference/models/black-forest-labs-flux-2-klein-4b.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `input_image` | `array<string>` | &mdash; | Input images to transform or use as reference. Reference them in the prompt as @Image1, @Image2, etc. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect ratio for the generated image One of: 1:1, 16:9, 9:16, 4:3, 3:4. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect Ratio One of: 1:1, 16:9, 9:16, 4:3, 3:4. |
| `output_quality` | `string` | `"standard"` | Quality setting for output image One of: standard, high. |
| `output_format` | `string` | `"png"` | Format of the output image One of: png, jpg, webp. |
| `seed` | `integer` | &mdash; | Random seed. Leave blank to randomize |
Expand Down
2 changes: 1 addition & 1 deletion inference-api/reference/models/black-forest-labs-flux-2-klein-9b.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `input_image` | `array<string>` | &mdash; | Input images to transform or use as reference. Reference them in the prompt as @Image1, @Image2, etc. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect ratio for the generated image One of: 1:1, 16:9, 9:16, 4:3, 3:4. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect Ratio One of: 1:1, 16:9, 9:16, 4:3, 3:4. |
| `output_quality` | `string` | `"standard"` | Quality setting for output image One of: standard, high. |
| `output_format` | `string` | `"png"` | Format of the output image One of: png, jpg, webp. |
| `seed` | `integer` | &mdash; | Random seed. Leave blank to randomize |
Expand Down
2 changes: 1 addition & 1 deletion inference-api/reference/models/bytedance-depth-anything-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/
|-------|------|---------|-------------|
| `depth_model` | `string` | `"VDA-Large"` | Depth estimation model size. VDA-Large = best quality, VDA-Small = fastest. One of: VDA-Small, VDA-Base, VDA-Large. |
| `colormap` | `string` | `"grayscale"` | Colormap for depth visualization. One of: grayscale, turbo, inferno, magma, viridis. |
| `resolution` | `string` | `"auto"` | Output resolution. Auto preserves input resolution up to 1080p. One of: auto, 360p, 480p, 720p, 1080p. |
| `resolution` | `string` | `"auto"` | Resolution One of: auto, 360p, 480p, 720p, 1080p. |
| `max_frames` | `integer` | &mdash; | Maximum number of frames to process. Leave unset to process all frames. |
| `output_fps` | `number` | &mdash; | Output video FPS. Leave unset to use the input frame rate. |
| `side_by_side` | `boolean` | `false` | If true, output a side-by-side original and depth comparison video. |
Expand Down
44 changes: 22 additions & 22 deletions inference-api/reference/models/bytedance-seedance-2-0-fast-image-to-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}'
```
Expand All @@ -149,10 +149,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -331,10 +331,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -372,10 +372,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -564,10 +564,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -602,10 +602,10 @@ ByteDance Seedance 2.0 Fast animates a starting frame with optional end-frame tr
"input_image_has_face": false,
"tail_image_url": "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
"tail_image_url_has_face": false,
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -660,8 +660,8 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/
| `input_image_has_face` | `boolean` | `false` | Turn this on when the start frame contains a real human face. Content filters may block the request if this is not enabled. |
| `tail_image_url` | `string` | &mdash; | Optional URL of the end-frame image for first+last-frame transitions. Format: uri. |
| `tail_image_url_has_face` | `boolean` | `false` | Turn this on when the end frame contains a real human face. Content filters may block the request if this is not enabled. |
| `resolution` | `string` | `"720p"` | Video resolution. One of: 480p, 720p. |
| `duration` | `integer` | `-1` | Duration of the video in seconds. Supports 4 to 15 seconds, or auto to let the model decide based on the prompt. One of: -1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15. |
| `aspect_ratio` | `string` | `"16:9"` | The aspect ratio of the generated video. Use 16:9 for landscape, 9:16 for portrait/vertical, 1:1 for square, 21:9 for ultrawide cinematic, or auto to let the model decide. One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `generate_audio` | `boolean` | `false` | Whether to generate synchronized audio. |
| `generate_audio` | `boolean` | `true` | Whether to generate synchronized audio. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect Ratio One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `duration` | `integer` | `-1` | Duration Range: 4 – 15. |
| `resolution` | `string` | `"720p"` | Resolution One of: 480p, 720p. |
| `watermark` | `boolean` | `false` | Whether to add an 'AI generated' watermark to the output. |
44 changes: 22 additions & 22 deletions inference-api/reference/models/bytedance-seedance-2-0-fast-reference-to-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}'
```
Expand Down Expand Up @@ -191,10 +191,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -404,10 +404,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -456,10 +456,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -679,10 +679,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -728,10 +728,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt guided by referen
"input_audios": [
"https://example.com/audio.mp3"
],
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -787,8 +787,8 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/
| `input_face_videos` | `array<string>` | &mdash; | Place reference videos here when they show a real human face. Content filters may block the request otherwise. |
| `input_videos` | `array<string>` | &mdash; | Reference videos that guide the generated video. Up to 3 total reference videos and up to 15 total references across all types may be used. |
| `input_audios` | `array<string>` | &mdash; | Reference audios that guide the generated video. Up to 3 total reference audios and up to 15 total references across all types may be used. |
| `resolution` | `string` | `"720p"` | Video resolution. One of: 480p, 720p. |
| `duration` | `integer` | `-1` | Duration of the video in seconds. Supports 4 to 15 seconds, or auto to let the model decide based on the prompt. One of: -1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15. |
| `aspect_ratio` | `string` | `"16:9"` | The aspect ratio of the generated video. Use 16:9 for landscape, 9:16 for portrait/vertical, 1:1 for square, 21:9 for ultrawide cinematic, or auto to let the model decide. One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `generate_audio` | `boolean` | `false` | Whether to generate synchronized audio. |
| `generate_audio` | `boolean` | `true` | Whether to generate synchronized audio. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect Ratio One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `duration` | `integer` | `-1` | Duration Range: 4 – 15. |
| `resolution` | `string` | `"720p"` | Resolution One of: 480p, 720p. |
| `watermark` | `boolean` | `false` | Whether to add an 'AI generated' watermark to the output. |
44 changes: 22 additions & 22 deletions inference-api/reference/models/bytedance-seedance-2-0-fast-text-to-video.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
-d '{
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}'
```
Expand All @@ -95,10 +95,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
json={
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -196,10 +196,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
-d '{
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -233,10 +233,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
json={
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -346,10 +346,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
-d '{
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
}' | jq -r '.generations[0].generation_id')

Expand Down Expand Up @@ -380,10 +380,10 @@ ByteDance Seedance 2.0 Fast generates video from a text prompt, optimized for sp
json={
"model": "bytedance-seedance-2-0-fast-text-to-video",
"prompt": "<prompt>",
"resolution": "720p",
"duration": -1,
"generate_audio": true,
"aspect_ratio": "16:9",
"generate_audio": false,
"duration": -1,
"resolution": "720p",
"watermark": false
},
)
Expand Down Expand Up @@ -434,8 +434,8 @@ curl -H "Authorization: Bearer $OXEN_API_KEY" https://hub.oxen.ai/api/ai/models/

| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `resolution` | `string` | `"720p"` | Video resolution. One of: 480p, 720p. |
| `duration` | `integer` | `-1` | Duration of the video in seconds. Supports 4 to 15 seconds, or auto to let the model decide based on the prompt. One of: -1, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15. |
| `aspect_ratio` | `string` | `"16:9"` | The aspect ratio of the generated video. Use 16:9 for landscape, 9:16 for portrait/vertical, 1:1 for square, 21:9 for ultrawide cinematic, or auto to let the model decide. One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `generate_audio` | `boolean` | `false` | Whether to generate synchronized audio. |
| `generate_audio` | `boolean` | `true` | Whether to generate synchronized audio. |
| `aspect_ratio` | `string` | `"16:9"` | Aspect Ratio One of: adaptive, 21:9, 16:9, 4:3, 1:1, 3:4, 9:16. |
| `duration` | `integer` | `-1` | Duration Range: 4 – 15. |
| `resolution` | `string` | `"720p"` | Resolution One of: 480p, 720p. |
| `watermark` | `boolean` | `false` | Whether to add an 'AI generated' watermark to the output. |
Loading