diff --git a/.vitepress/modelApiReferenceSidebar.generated.ts b/.vitepress/modelApiReferenceSidebar.generated.ts index 2ab1559d..a4dcaf8d 100644 --- a/.vitepress/modelApiReferenceSidebar.generated.ts +++ b/.vitepress/modelApiReferenceSidebar.generated.ts @@ -171,6 +171,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "OpenAI", collapsed: true, items: [ + { text: "GPT-6 Astra", link: "/model-api-reference/llm-models/openai/gpt-6-astra" }, { text: "GPT-5.6 Luna Pro", link: "/model-api-reference/llm-models/openai/gpt-5.6-luna-pro" }, { text: "GPT-5.6 Luna", link: "/model-api-reference/llm-models/openai/gpt-5.6-luna" }, { text: "GPT-5.6 Terra Pro", link: "/model-api-reference/llm-models/openai/gpt-5.6-terra-pro" }, @@ -247,6 +248,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Anthropic", collapsed: true, items: [ + { text: "Claude Fable 5.1", link: "/model-api-reference/llm-models/anthropic/claude-fable-5.1" }, { text: "Claude Opus 5", link: "/model-api-reference/llm-models/anthropic/claude-opus-5" }, { text: "Claude Sonnet 5", link: "/model-api-reference/llm-models/anthropic/claude-sonnet-5" }, { text: "Claude Fable 5", link: "/model-api-reference/llm-models/anthropic/claude-fable-5" }, @@ -274,10 +276,10 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Google", collapsed: true, items: [ + { text: "Gemini 3.8 Flash", link: "/model-api-reference/llm-models/google/gemini-3.8-flash" }, { text: "Gemini 3.7 Flash", link: "/model-api-reference/llm-models/google/gemini-3.7-flash" }, { text: "Gemini 3.5 Flash Lite", link: "/model-api-reference/llm-models/google/gemini-3.5-flash-lite" }, { text: "Gemini 3.6 Flash", link: "/model-api-reference/llm-models/google/gemini-3.6-flash" }, - { text: "Gemini Omni Flash Preview", link: "/model-api-reference/llm-models/google/gemini-omni-flash-preview" }, { text: "Nano Banana 2 (Gemini 3.1 Flash Image)", link: "/model-api-reference/llm-models/google/gemini-3.1-flash-image" }, { text: "Nano Banana Pro (Gemini 3 Pro Image)", link: "/model-api-reference/llm-models/google/gemini-3-pro-image" }, { text: "Gemini 3.5 Flash", link: "/model-api-reference/llm-models/google/gemini-3.5-flash" }, @@ -312,6 +314,8 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "DeepSeek", collapsed: true, items: [ + { text: "DeepSeek V4.1 Flash", link: "/model-api-reference/llm-models/deepseek/deepseek-v4.1-flash" }, + { text: "DeepSeek V4 Flash Vision Exp (Experimental)", link: "/model-api-reference/llm-models/deepseek/deepseek-v4-flash-vision-exp" }, { text: "DeepSeek V4 Flash 0731", link: "/model-api-reference/llm-models/deepseek/deepseek-v4-flash-0731" }, { text: "DeepSeek V4 Pro", link: "/model-api-reference/llm-models/deepseek/deepseek-v4-pro" }, { text: "DeepSeek V4 Flash", link: "/model-api-reference/llm-models/deepseek/deepseek-v4-flash" }, @@ -333,6 +337,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Alibaba", collapsed: true, items: [ + { text: "Qwen: Qwen3.8 27B", link: "/model-api-reference/llm-models/alibaba/qwen3.8-27b" }, { text: "Qwen: Qwen3.8 2.4T A95B", link: "/model-api-reference/llm-models/alibaba/qwen3.8-2.4t-a95b" }, { text: "Qwen: Qwen3.8 Max", link: "/model-api-reference/llm-models/alibaba/qwen3.8-max" }, { text: "Qwen: Qwen3.7 Plus", link: "/model-api-reference/llm-models/alibaba/qwen3.7-plus" }, @@ -853,6 +858,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Tencent", collapsed: true, items: [ + { text: "Hy4 preview", link: "/model-api-reference/llm-models/tencent/hy4-preview" }, { text: "Hy3", link: "/model-api-reference/llm-models/tencent/hy3" }, { text: "Hy3 preview", link: "/model-api-reference/llm-models/tencent/hy3-preview" }, { text: "Hunyuan A13B Instruct", link: "/model-api-reference/llm-models/tencent/hunyuan-a13b-instruct" }, @@ -870,6 +876,14 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ ], }, // Duplicate model names are qualified with provider and operation path for navigation clarity. + { + text: "TypeSafe", + collapsed: true, + items: [ + { text: "Jev 1.13", link: "/model-api-reference/llm-models/typesafe/jev-1.13" }, + ], + }, + // Duplicate model names are qualified with provider and operation path for navigation clarity. { text: "Undi95", collapsed: true, @@ -882,6 +896,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Upstage", collapsed: true, items: [ + { text: "Solar Pro 4", link: "/model-api-reference/llm-models/upstage/solar-pro4" }, { text: "Solar Pro 3", link: "/model-api-reference/llm-models/upstage/solar-pro-3" }, ], }, @@ -909,6 +924,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Z-Ai", collapsed: true, items: [ + { text: "Z.ai: GLM 5.3", link: "/model-api-reference/llm-models/z-ai/glm-5.3" }, { text: "Z.ai: GLM 5.2", link: "/model-api-reference/llm-models/z-ai/glm-5.2" }, { text: "Z.ai: GLM 5.1", link: "/model-api-reference/llm-models/z-ai/glm-5.1" }, { text: "Z.ai: GLM 5V Turbo", link: "/model-api-reference/llm-models/z-ai/glm-5v-turbo" }, @@ -938,6 +954,10 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ items: [ { text: "GPT Image 2 Official API", link: "/model-api-reference/image-generation/openai/gpt-image-2-official" }, { text: "GPT Image 2 Official Edit API", link: "/model-api-reference/image-generation/openai/gpt-image-2-official/edit" }, + { text: "GPT Image 2.5 Flare", link: "/model-api-reference/image-generation/openai/gpt-image-2.5-flare" }, + { text: "GPT Image 2.5 Flare Edit", link: "/model-api-reference/image-generation/openai/gpt-image-2.5-flare/edit" }, + { text: "GPT Image 2.5 Sunburst", link: "/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst" }, + { text: "GPT Image 2.5 Sunburst Edit", link: "/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst/edit" }, { text: "GPT Image 2", link: "/model-api-reference/image-generation/openai/gpt-image-2" }, { text: "GPT Image 2 Editing", link: "/model-api-reference/image-generation/openai/gpt-image-2/edit" }, { text: "GPT-Image 1.5", link: "/model-api-reference/image-generation/openai/gpt-image-1.5/edit" }, @@ -992,14 +1012,14 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ { text: "Seedream 5.0 Pro Image Editing", link: "/model-api-reference/image-generation/bytedance/seedream/5.0/pro/edit" }, { text: "Seedream 5.0 Pro Text to Image", link: "/model-api-reference/image-generation/bytedance/seedream/5.0/pro" }, { text: "SeedVR2 (ByteDance: seedvr / upscale / image / seamless)", link: "/model-api-reference/image-generation/bytedance/seedvr/upscale/image/seamless" }, - { text: "ByteDance Seed 2.0 Mini", link: "/model-api-reference/image-generation/bytedance/seed/v2/mini" }, + { text: "Bytedance Seed 2.0 Mini", link: "/model-api-reference/image-generation/bytedance/seed/v2/mini" }, { text: "Seedream v5.0 Lite", link: "/model-api-reference/image-generation/bytedance/seedream/5.0/lite" }, { text: "Seedream v4.5", link: "/model-api-reference/image-generation/bytedance/seedream/4.5" }, { text: "Seedream v4.5 Image Editing", link: "/model-api-reference/image-generation/bytedance/seedream/4.5/edit" }, { text: "SeedVR2 (ByteDance: seedvr / upscale / video)", link: "/model-api-reference/image-generation/bytedance/seedvr/upscale/video" }, { text: "SeedVR2 (ByteDance: seedvr / upscale / image)", link: "/model-api-reference/image-generation/bytedance/seedvr/upscale/image" }, - { text: "ByteDance Seedream v4 Edit", link: "/model-api-reference/image-generation/bytedance/seedream/4.0/edit" }, - { text: "ByteDance Seedream v4", link: "/model-api-reference/image-generation/bytedance/seedream/4.0" }, + { text: "Bytedance Seedream v4 Edit", link: "/model-api-reference/image-generation/bytedance/seedream/4.0/edit" }, + { text: "Bytedance Seedream v4", link: "/model-api-reference/image-generation/bytedance/seedream/4.0" }, { text: "Dreamina 3.1", link: "/model-api-reference/image-generation/bytedance/dreamina/3.1" }, { text: "Seedream v5.0 Lite Editing", link: "/model-api-reference/image-generation/bytedance/seedream/5.0/lite/edit" }, ], @@ -1451,6 +1471,14 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ ], }, // Duplicate model names are qualified with provider and operation path for navigation clarity. + { + text: "Midjourney", + collapsed: true, + items: [ + { text: "Midjourney V8.1", link: "/model-api-reference/image-generation/midjourney/midjourney-v8.1" }, + ], + }, + // Duplicate model names are qualified with provider and operation path for navigation clarity. { text: "MiniMax", collapsed: true, @@ -1606,6 +1634,14 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Topaz Labs", collapsed: true, items: [ + { text: "Topaz Adjust Image", link: "/model-api-reference/image-generation/topaz/adjust/image" }, + { text: "Topaz Sharpen Image", link: "/model-api-reference/image-generation/topaz/sharpen/image" }, + { text: "Topaz Denoise Image", link: "/model-api-reference/image-generation/topaz/denoise/image" }, + { text: "Topaz Restore Image", link: "/model-api-reference/image-generation/topaz/restore/image" }, + { text: "Topaz Upscale Image Transparent", link: "/model-api-reference/image-generation/topaz/upscale/image/transparent" }, + { text: "Topaz Upscale Image Creative", link: "/model-api-reference/image-generation/topaz/upscale/image/creative" }, + { text: "Topaz Upscale Image Generative", link: "/model-api-reference/image-generation/topaz/upscale/image/generative" }, + { text: "Topaz Upscale Image Precision", link: "/model-api-reference/image-generation/topaz/upscale/image/precision" }, { text: "Topaz Upscale", link: "/model-api-reference/image-generation/topaz/upscale/image" }, ], }, @@ -1700,6 +1736,9 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ { text: "Seedance 2.5 Image to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.5/image-to-video" }, { text: "Seedance 2.5 Reference to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.5/reference-to-video" }, { text: "Seedance 2.5 Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.5/text-to-video" }, + { text: "Seedance 2.0 Mini", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/reference-to-video" }, + { text: "Seedance 2.0 Mini Image to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/image-to-video" }, + { text: "Seedance 2.0 Mini Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/text-to-video" }, { text: "Seedance 2.0 Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/text-to-video" }, { text: "Seedance 2.0 Reference to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/reference-to-video" }, { text: "Seedance 2.0 Fast Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/fast/text-to-video" }, @@ -1709,14 +1748,11 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ { text: "DreamActor 2.0", link: "/model-api-reference/video-generation/bytedance/dreamactor/2.0" }, { text: "Seedance v1.5 Pro Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/1.5/pro/text-to-video" }, { text: "Seedance v1.5 Pro Image to Video", link: "/model-api-reference/video-generation/bytedance/seedance/1.5/pro/image-to-video" }, - { text: "Seedance 2.0 Mini Text to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/text-to-video" }, - { text: "Seedance 2.0 Mini Image to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/image-to-video" }, - { text: "Seedance 2.0 Mini Reference to Video", link: "/model-api-reference/video-generation/bytedance/seedance/2.0/mini/reference-to-video" }, { text: "Lynx", link: "/model-api-reference/video-generation/bytedance/lynx" }, - { text: "ByteDance Video Upscaler", link: "/model-api-reference/video-generation/bytedance/upscaler/video" }, + { text: "Bytedance Video Upscaler", link: "/model-api-reference/video-generation/bytedance/upscaler/video" }, { text: "Seedance 1.0 Pro Fast I2V", link: "/model-api-reference/video-generation/bytedance/seedance/1.0/pro/fast/image-to-video" }, { text: "Seedance 1.0 Pro Fast T2V", link: "/model-api-reference/video-generation/bytedance/seedance/1.0/pro/fast/text-to-video" }, - { text: "ByteDance OmniHuman v1.5", link: "/model-api-reference/video-generation/bytedance/omnihuman/1.5" }, + { text: "Bytedance OmniHuman v1.5", link: "/model-api-reference/video-generation/bytedance/omnihuman/1.5" }, { text: "Video Stylize", link: "/model-api-reference/video-generation/bytedance/video-stylize" }, { text: "OmniHuman 1.0", link: "/model-api-reference/video-generation/bytedance/omnihuman/1.0" }, { text: "Seedance 1.0 Pro (ByteDance: seedance / 1.0 / pro / text-to-video)", link: "/model-api-reference/video-generation/bytedance/seedance/1.0/pro/text-to-video" }, @@ -1777,6 +1813,9 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "MiniMax", collapsed: true, items: [ + { text: "H3 Max Reference to Video", link: "/model-api-reference/video-generation/minimax/h3-max/reference-to-video" }, + { text: "H3 Max Image to Video", link: "/model-api-reference/video-generation/minimax/h3-max/image-to-video" }, + { text: "MiniMax H3 Max Text to Video", link: "/model-api-reference/video-generation/minimax/h3-max/text-to-video" }, { text: "MiniMax H3 Video Regeneration", link: "/model-api-reference/video-generation/minimax/h3/video-regeneration" }, { text: "MiniMax H3 (Text to Video)", link: "/model-api-reference/video-generation/minimax/h3/text-to-video" }, { text: "MiniMax H3 (Image to Video)", link: "/model-api-reference/video-generation/minimax/h3/image-to-video" }, @@ -1840,6 +1879,8 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Alibaba", collapsed: true, items: [ + { text: "Wan 3.0 Prime", link: "/model-api-reference/video-generation/alibaba/wan/3.0/prime/video" }, + { text: "Wan 3.0 Video", link: "/model-api-reference/video-generation/alibaba/wan/3.0/video" }, { text: "Happy Horse 1.1 Image to Video", link: "/model-api-reference/video-generation/alibaba/happy-horse/1.1/image-to-video" }, { text: "Happy Horse 1.1 Reference to Video", link: "/model-api-reference/video-generation/alibaba/happy-horse/1.1/reference-to-video" }, { text: "Happy Horse 1.1 Text to Video", link: "/model-api-reference/video-generation/alibaba/happy-horse/1.1/text-to-video" }, @@ -2307,7 +2348,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "Google", collapsed: true, items: [ - { text: "Gemini 3.1 Flash Tts", link: "/model-api-reference/audio-generation/google/gemini-3.1-flash-tts" }, + { text: "Gemini 3.1 Flash TTS", link: "/model-api-reference/audio-generation/google/gemini-3.1-flash-tts" }, { text: "Gemini TTS", link: "/model-api-reference/audio-generation/google/gemini-tts" }, { text: "Lyria2", link: "/model-api-reference/audio-generation/google/lyria-2" }, ], @@ -2382,7 +2423,7 @@ export const modelApiReferenceSidebarItems: DefaultTheme.SidebarItem[] = [ text: "ByteDance", collapsed: true, items: [ - { text: "ByteDance Seed Speech Text to Speech", link: "/model-api-reference/audio-generation/bytedance/seed-speech/tts/2.0" }, + { text: "Bytedance Seed Speech Text to Speech", link: "/model-api-reference/audio-generation/bytedance/seed-speech/tts/2.0" }, ], }, // Duplicate model names are qualified with provider and operation path for navigation clarity. diff --git a/model-api-reference/image-generation.md b/model-api-reference/image-generation.md index 4dbbe426..86515efe 100644 --- a/model-api-reference/image-generation.md +++ b/model-api-reference/image-generation.md @@ -15,14 +15,17 @@ Image Generation models use the SandBase generation protocol declared in each mo - [GPT Image 2 Official API](/model-api-reference/image-generation/openai/gpt-image-2-official) — GPT Image 2 through the OpenAI Images API contract. - [GPT Image 2 Official Edit API](/model-api-reference/image-generation/openai/gpt-image-2-official/edit) — GPT Image 2 editing through the OpenAI Images API contract. +- [GPT Image 2.5 Flare](/model-api-reference/image-generation/openai/gpt-image-2.5-flare) — GPT Image 2.5 Flare is optimized for fast, high-quality image generation for everyday creative workflows. +- [GPT Image 2.5 Flare Edit](/model-api-reference/image-generation/openai/gpt-image-2.5-flare/edit) — GPT Image 2.5 Flare Edit is optimized for fast, high-quality image editing and multi-image composition. +- [GPT Image 2.5 Sunburst](/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst) — GPT Image 2.5 Sunburst prioritizes visual fidelity and precision for complex image generation workflows. +- [GPT Image 2.5 Sunburst Edit](/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst/edit) — GPT Image 2.5 Sunburst Edit prioritizes precision and visual fidelity for complex image editing workflows. - [GPT Image 2](/model-api-reference/image-generation/openai/gpt-image-2) — GPT Image 2, OpenAI's available image model, is capable of making fine-grained, detailed edits to images. - [GPT Image 2 Editing](/model-api-reference/image-generation/openai/gpt-image-2/edit) — GPT Image 2 Editing supports image editing and multi-image synthesis with high-quality results. - [GPT-Image 1.5](/model-api-reference/image-generation/openai/gpt-image-1.5/edit) — Gpt Image 1.5 Edit by OpenAI - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. - [GPT Image 1.5](/model-api-reference/image-generation/openai/gpt-image-1.5) — Gpt Image 1.5 is OpenAI's advanced text-to-image AI model. Create photorealistic images, illustrations, and concept art from natural language descriptions with exceptional detail and prompt adherence. - [GPT Image 1 Mini Edit](/model-api-reference/image-generation/openai/gpt-image-1-mini/edit) — Gpt Image 1 Mini Edit is OpenAI's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. - [GPT Image 1 Mini](/model-api-reference/image-generation/openai/gpt-image-1-mini) — Gpt Image 1 Mini by OpenAI - generate stunning images from text prompts with state-of-the-art AI. Supports multiple aspect ratios, styles, and high-resolution output for creative and commercial use. -- [GPT Image 1](/model-api-reference/image-generation/openai/gpt-image-1) — Gpt Image 1 is OpenAI's advanced text-to-image AI model. Create photorealistic images, illustrations, and concept art from natural language descriptions with exceptional detail and prompt adherence. -- [GPT Image 1 Edit](/model-api-reference/image-generation/openai/gpt-image-1/edit) — Gpt Image 1 Edit by OpenAI - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. +- …and 2 more models in the sidebar. ### Google @@ -269,6 +272,10 @@ Image Generation models use the SandBase generation protocol declared in each mo - [MAI Image 2.5 Pro (Edit)](/model-api-reference/image-generation/microsoft/mai-image-2.5-pro/edit) — Mai Image 2.5 Pro Edit by Microsoft - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. - [Mai Image 2.5](/model-api-reference/image-generation/microsoft/mai-image-2.5/edit) — Mai Image 2.5 Edit by Microsoft - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. +### Midjourney + +- [Midjourney V8.1](/model-api-reference/image-generation/midjourney/midjourney-v8.1) — Midjourney V8.1 text-to-image generation through Evolink.ai. + ### MiniMax - [Minimax Image Subject Reference](/model-api-reference/image-generation/minimax/image-01/subject-reference) — Image 01 Subject Reference by MiniMax - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. @@ -362,6 +369,14 @@ Image Generation models use the SandBase generation protocol declared in each mo ### Topaz Labs +- [Topaz Adjust Image](/model-api-reference/image-generation/topaz/adjust/image) — Adjust Image by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. +- [Topaz Sharpen Image](/model-api-reference/image-generation/topaz/sharpen/image) — Sharpen Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. +- [Topaz Denoise Image](/model-api-reference/image-generation/topaz/denoise/image) — Denoise Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. +- [Topaz Restore Image](/model-api-reference/image-generation/topaz/restore/image) — Restore Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. +- [Topaz Upscale Image Transparent](/model-api-reference/image-generation/topaz/upscale/image/transparent) — Upscale Image Transparent is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. +- [Topaz Upscale Image Creative](/model-api-reference/image-generation/topaz/upscale/image/creative) — Upscale Image Creative by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. +- [Topaz Upscale Image Generative](/model-api-reference/image-generation/topaz/upscale/image/generative) — Upscale Image Generative by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly. +- [Topaz Upscale Image Precision](/model-api-reference/image-generation/topaz/upscale/image/precision) — Upscale Image Precision is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. - [Topaz Upscale](/model-api-reference/image-generation/topaz/upscale/image) — Upscale Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion. ### trellis diff --git a/model-api-reference/image-generation/midjourney/midjourney-v8.1.md b/model-api-reference/image-generation/midjourney/midjourney-v8.1.md new file mode 100644 index 00000000..a583ec21 --- /dev/null +++ b/model-api-reference/image-generation/midjourney/midjourney-v8.1.md @@ -0,0 +1,21 @@ +--- +title: "Midjourney V8.1 API Reference" +description: "Midjourney V8.1 API reference for SandBase. Use model midjourney/midjourney-v8.1 with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/midjourney/midjourney-v8.1" +apiReferenceJson: "{\"title\":\"Midjourney V8.1\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Midjourney V8.1 text-to-image generation through Evolink.ai.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to midjourney/midjourney-v8.1.\",\"default\":\"midjourney/midjourney-v8.1\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt used to generate the image.\"},{\"name\":\"speed\",\"type\":\"string\",\"required\":false,\"description\":\"Generation speed.\",\"default\":\"fast\",\"constraints\":\"Allowed values: draft, fast\"},{\"name\":\"quality\",\"type\":\"string\",\"required\":false,\"description\":\"Output quality. HD is unavailable with draft speed.\",\"default\":\"standard\",\"constraints\":\"Allowed values: standard, hd\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"text-to-image, commercial\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"midjourney/midjourney-v8.1\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"midjourney/midjourney-v8.1\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"midjourney/midjourney-v8.1\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"midjourney/midjourney-v8.1\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Midjourney V8.1" + modelId: "midjourney/midjourney-v8.1" + vendor: "Midjourney" + vendorSlug: "midjourney" + modelSlug: "midjourney-v8.1" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "" + capabilities: ["text-to-image","commercial"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/openai/gpt-image-2.5-flare.md b/model-api-reference/image-generation/openai/gpt-image-2.5-flare.md new file mode 100644 index 00000000..90d13bc0 --- /dev/null +++ b/model-api-reference/image-generation/openai/gpt-image-2.5-flare.md @@ -0,0 +1,21 @@ +--- +title: "GPT Image 2.5 Flare API Reference" +description: "GPT Image 2.5 Flare API reference for SandBase. Use model openai/gpt-image-2.5-flare with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/openai/gpt-image-2.5-flare" +apiReferenceJson: "{\"title\":\"GPT Image 2.5 Flare\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"GPT Image 2.5 Flare is optimized for fast, high-quality image generation for everyday creative workflows.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to openai/gpt-image-2.5-flare.\",\"default\":\"openai/gpt-image-2.5-flare\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"The text prompt to generate an image from.\",\"default\":\"Generate an image of gray tabby cat hugging an otter with an orange scarf\"},{\"name\":\"quality\",\"type\":\"string\",\"required\":false,\"description\":\"Quality for the generated image\",\"default\":\"high\",\"constraints\":\"Allowed values: low, medium, high\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The resolution of the generated image. Leave unset to preserve the provider's standard dimensions.\",\"constraints\":\"Allowed values: 1k, 2k, 4k\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"default\":\"1:1\",\"constraints\":\"Allowed values: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"The format of the generated image.\",\"default\":\"png\",\"constraints\":\"Allowed values: jpeg, png, webp\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"text-to-image, commercial\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "GPT Image 2.5 Flare" + modelId: "openai/gpt-image-2.5-flare" + vendor: "OpenAI" + vendorSlug: "openai" + modelSlug: "gpt-image-2.5-flare" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-20T00:00:00Z" + capabilities: ["text-to-image","commercial"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/openai/gpt-image-2.5-flare/edit.md b/model-api-reference/image-generation/openai/gpt-image-2.5-flare/edit.md new file mode 100644 index 00000000..3a62708c --- /dev/null +++ b/model-api-reference/image-generation/openai/gpt-image-2.5-flare/edit.md @@ -0,0 +1,21 @@ +--- +title: "GPT Image 2.5 Flare Edit API Reference" +description: "GPT Image 2.5 Flare Edit API reference for SandBase. Use model openai/gpt-image-2.5-flare/edit with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/openai/gpt-image-2.5-flare/edit" +apiReferenceJson: "{\"title\":\"GPT Image 2.5 Flare Edit\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"GPT Image 2.5 Flare Edit is optimized for fast, high-quality image editing and multi-image composition.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to openai/gpt-image-2.5-flare/edit.\",\"default\":\"openai/gpt-image-2.5-flare/edit\"},{\"name\":\"images\",\"type\":\"array\",\"required\":true,\"description\":\"The URLs of the images to use for image-to-image generation or image editing.\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"The text prompt to generate an image from.\",\"default\":\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\"},{\"name\":\"quality\",\"type\":\"string\",\"required\":false,\"description\":\"Quality for the generated image\",\"default\":\"high\",\"constraints\":\"Allowed values: low, medium, high\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The resolution of the generated image. Leave unset to preserve the provider's standard dimensions.\",\"constraints\":\"Allowed values: 1k, 2k, 4k\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"constraints\":\"Allowed values: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"The format of the generated image.\",\"default\":\"png\",\"constraints\":\"Allowed values: jpeg, png, webp\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image, commercial\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"openai/gpt-image-2.5-flare/edit\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "GPT Image 2.5 Flare Edit" + modelId: "openai/gpt-image-2.5-flare/edit" + vendor: "OpenAI" + vendorSlug: "openai" + modelSlug: "gpt-image-2.5-flare/edit" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-20T00:00:00Z" + capabilities: ["image-to-image","commercial"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst.md b/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst.md new file mode 100644 index 00000000..475c33cb --- /dev/null +++ b/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst.md @@ -0,0 +1,21 @@ +--- +title: "GPT Image 2.5 Sunburst API Reference" +description: "GPT Image 2.5 Sunburst API reference for SandBase. Use model openai/gpt-image-2.5-sunburst with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/openai/gpt-image-2.5-sunburst" +apiReferenceJson: "{\"title\":\"GPT Image 2.5 Sunburst\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"GPT Image 2.5 Sunburst prioritizes visual fidelity and precision for complex image generation workflows.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to openai/gpt-image-2.5-sunburst.\",\"default\":\"openai/gpt-image-2.5-sunburst\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"The text prompt to generate an image from.\",\"default\":\"Generate an image of gray tabby cat hugging an otter with an orange scarf\"},{\"name\":\"quality\",\"type\":\"string\",\"required\":false,\"description\":\"Quality for the generated image\",\"default\":\"high\",\"constraints\":\"Allowed values: low, medium, high\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The resolution of the generated image. Leave unset to preserve the provider's standard dimensions.\",\"constraints\":\"Allowed values: 1k, 2k, 4k\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"default\":\"1:1\",\"constraints\":\"Allowed values: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"The format of the generated image.\",\"default\":\"png\",\"constraints\":\"Allowed values: jpeg, png, webp\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"text-to-image, commercial\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst\\\",\\n \\\"prompt\\\": \\\"Generate an image of gray tabby cat hugging an otter with an orange scarf\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "GPT Image 2.5 Sunburst" + modelId: "openai/gpt-image-2.5-sunburst" + vendor: "OpenAI" + vendorSlug: "openai" + modelSlug: "gpt-image-2.5-sunburst" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-20T00:00:00Z" + capabilities: ["text-to-image","commercial"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst/edit.md b/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst/edit.md new file mode 100644 index 00000000..e2c982f6 --- /dev/null +++ b/model-api-reference/image-generation/openai/gpt-image-2.5-sunburst/edit.md @@ -0,0 +1,21 @@ +--- +title: "GPT Image 2.5 Sunburst Edit API Reference" +description: "GPT Image 2.5 Sunburst Edit API reference for SandBase. Use model openai/gpt-image-2.5-sunburst/edit with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/openai/gpt-image-2.5-sunburst/edit" +apiReferenceJson: "{\"title\":\"GPT Image 2.5 Sunburst Edit\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"GPT Image 2.5 Sunburst Edit prioritizes precision and visual fidelity for complex image editing workflows.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to openai/gpt-image-2.5-sunburst/edit.\",\"default\":\"openai/gpt-image-2.5-sunburst/edit\"},{\"name\":\"images\",\"type\":\"array\",\"required\":true,\"description\":\"The URLs of the images to use for image-to-image generation or image editing.\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"The text prompt to generate an image from.\",\"default\":\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\"},{\"name\":\"quality\",\"type\":\"string\",\"required\":false,\"description\":\"Quality for the generated image\",\"default\":\"high\",\"constraints\":\"Allowed values: low, medium, high\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The resolution of the generated image. Leave unset to preserve the provider's standard dimensions.\",\"constraints\":\"Allowed values: 1k, 2k, 4k\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"constraints\":\"Allowed values: 1:1, 1:2, 2:1, 1:3, 3:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 9:21, 21:9\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"The format of the generated image.\",\"default\":\"png\",\"constraints\":\"Allowed values: jpeg, png, webp\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image, commercial\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst/edit\\\",\\n \\\"images\\\": [\\n \\\"https://cdn.openai.com/API/docs/images/body-lotion.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/soap.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/incense-kit.png\\\",\\n \\\"https://cdn.openai.com/API/docs/images/bath-bomb.png\\\"\\n ],\\n \\\"prompt\\\": \\\"Generate a photorealistic image of a gift basket on a white background labeled 'Relax & Unwind' with a ribbon and handwriting-like font, containing all the items in the reference pictures.\\\",\\n \\\"aspect_ratio\\\": \\\"1:1\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"openai/gpt-image-2.5-sunburst/edit\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "GPT Image 2.5 Sunburst Edit" + modelId: "openai/gpt-image-2.5-sunburst/edit" + vendor: "OpenAI" + vendorSlug: "openai" + modelSlug: "gpt-image-2.5-sunburst/edit" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-20T00:00:00Z" + capabilities: ["image-to-image","commercial"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/adjust/image.md b/model-api-reference/image-generation/topaz/adjust/image.md new file mode 100644 index 00000000..6b4704e8 --- /dev/null +++ b/model-api-reference/image-generation/topaz/adjust/image.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Adjust Image API Reference" +description: "Topaz Adjust Image API reference for SandBase. Use model topaz/adjust/image with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/adjust/image" +apiReferenceJson: "{\"title\":\"Topaz Adjust Image\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Adjust Image by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/adjust/image.\",\"default\":\"topaz/adjust/image\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to process\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the processed image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/adjust/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/adjust/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/adjust/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/adjust/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/adjust/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/adjust/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/adjust/image\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Adjust Image" + modelId: "topaz/adjust/image" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "adjust/image" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:43.374Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/denoise/image.md b/model-api-reference/image-generation/topaz/denoise/image.md new file mode 100644 index 00000000..c29db0c1 --- /dev/null +++ b/model-api-reference/image-generation/topaz/denoise/image.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Denoise Image API Reference" +description: "Topaz Denoise Image API reference for SandBase. Use model topaz/denoise/image with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/denoise/image" +apiReferenceJson: "{\"title\":\"Topaz Denoise Image\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Denoise Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/denoise/image.\",\"default\":\"topaz/denoise/image\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to process\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the processed image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/denoise/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/denoise/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/denoise/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/denoise/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/denoise/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/denoise/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/denoise/image\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Denoise Image" + modelId: "topaz/denoise/image" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "denoise/image" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:34.289Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/restore/image.md b/model-api-reference/image-generation/topaz/restore/image.md new file mode 100644 index 00000000..31306597 --- /dev/null +++ b/model-api-reference/image-generation/topaz/restore/image.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Restore Image API Reference" +description: "Topaz Restore Image API reference for SandBase. Use model topaz/restore/image with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/restore/image" +apiReferenceJson: "{\"title\":\"Topaz Restore Image\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Restore Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/restore/image.\",\"default\":\"topaz/restore/image\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to process\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the processed image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/restore/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/restore/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/restore/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/restore/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/restore/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/restore/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/restore/image\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Restore Image" + modelId: "topaz/restore/image" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "restore/image" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:29.313Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/sharpen/image.md b/model-api-reference/image-generation/topaz/sharpen/image.md new file mode 100644 index 00000000..f1facbcc --- /dev/null +++ b/model-api-reference/image-generation/topaz/sharpen/image.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Sharpen Image API Reference" +description: "Topaz Sharpen Image API reference for SandBase. Use model topaz/sharpen/image with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/sharpen/image" +apiReferenceJson: "{\"title\":\"Topaz Sharpen Image\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Sharpen Image is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/sharpen/image.\",\"default\":\"topaz/sharpen/image\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to process\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the processed image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/sharpen/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/sharpen/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/sharpen/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/sharpen/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/sharpen/image\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/sharpen/image/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/sharpen/image\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Sharpen Image" + modelId: "topaz/sharpen/image" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "sharpen/image" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:38.276Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/upscale/image/creative.md b/model-api-reference/image-generation/topaz/upscale/image/creative.md new file mode 100644 index 00000000..069c276b --- /dev/null +++ b/model-api-reference/image-generation/topaz/upscale/image/creative.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Upscale Image Creative API Reference" +description: "Topaz Upscale Image Creative API reference for SandBase. Use model topaz/upscale/image/creative with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/upscale/image/creative" +apiReferenceJson: "{\"title\":\"Topaz Upscale Image Creative\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Upscale Image Creative by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/upscale/image/creative.\",\"default\":\"topaz/upscale/image/creative\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to be upscaled\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the upscaled image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"},{\"name\":\"crop_to_fill\",\"type\":\"boolean\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"default\":\"false\"},{\"name\":\"upscale_factor\",\"type\":\"number\",\"required\":false,\"description\":\"Factor to upscale the image by (e.g. 2.0 doubles width and height)\",\"default\":\"2\",\"constraints\":\"Range: 1 to 4\"},{\"name\":\"autoprompt\",\"type\":\"boolean\",\"required\":false,\"description\":\"Enable automatic prompt generation. Applies to Bloom 2 only; Topaz defaults it to true when omitted.\"},{\"name\":\"color_preservation\",\"type\":\"boolean\",\"required\":false,\"description\":\"Preserve the source image's colors in the output. Applies to Bloom 2 only.\"},{\"name\":\"creativity\",\"type\":\"integer\",\"required\":false,\"description\":\"Creativity level (1-9). Higher values produce more creative/hallucinated details. Applies to Bloom 2 only.\",\"constraints\":\"Range: 1 to 9\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/upscale/image/creative\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/creative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/upscale/image/creative\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/creative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/upscale/image/creative\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/creative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/upscale/image/creative\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Upscale Image Creative" + modelId: "topaz/upscale/image/creative" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "upscale/image/creative" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:22.517Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/upscale/image/generative.md b/model-api-reference/image-generation/topaz/upscale/image/generative.md new file mode 100644 index 00000000..d83c8791 --- /dev/null +++ b/model-api-reference/image-generation/topaz/upscale/image/generative.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Upscale Image Generative API Reference" +description: "Topaz Upscale Image Generative API reference for SandBase. Use model topaz/upscale/image/generative with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/upscale/image/generative" +apiReferenceJson: "{\"title\":\"Topaz Upscale Image Generative\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Upscale Image Generative by Topaz Labs - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/upscale/image/generative.\",\"default\":\"topaz/upscale/image/generative\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt to guide generative upscaling (max 1024 chars). Applies to Redefine model only.\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to be upscaled\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the upscaled image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"},{\"name\":\"detail\",\"type\":\"number\",\"required\":false,\"description\":\"Detail recovery level (0.0-1.0). Applies to Recovery V2 model only.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"subject_detection\",\"type\":\"string\",\"required\":false,\"description\":\"Subject detection mode for the image enhancement. Applies to Wonder 3, Recovery and Recovery V2 models.\",\"default\":\"All\",\"constraints\":\"Allowed values: All, Foreground, Background\"},{\"name\":\"upscale_factor\",\"type\":\"number\",\"required\":false,\"description\":\"Factor to upscale the image by (e.g. 2.0 doubles width and height)\",\"default\":\"2\",\"constraints\":\"Range: 1 to 4\"},{\"name\":\"autoprompt\",\"type\":\"boolean\",\"required\":false,\"description\":\"Enable automatic prompt generation for generative upscaling. Applies to Redefine model only.\"},{\"name\":\"face_enhancement\",\"type\":\"boolean\",\"required\":false,\"description\":\"Whether to apply face enhancement to the image.\",\"default\":\"true\"},{\"name\":\"sharpen\",\"type\":\"number\",\"required\":false,\"description\":\"Sharpening level (0.0-1.0). Applies to Redefine model only.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"crop_to_fill\",\"type\":\"boolean\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"default\":\"false\"},{\"name\":\"face_enhancement_strength\",\"type\":\"number\",\"required\":false,\"description\":\"Strength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled.\",\"default\":\"0.8\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"creativity\",\"type\":\"integer\",\"required\":false,\"description\":\"Creativity level for generative upscaling (1-6). Higher values produce more creative/hallucinated details. Applies to Redefine model only.\",\"constraints\":\"Range: 1 to 6\"},{\"name\":\"enhancement_strength\",\"type\":\"string\",\"required\":false,\"description\":\"Enhancement strength for generative upscaling. Applies to Wonder 3 and Wonder 3.5 models. When omitted, Topaz auto-configures it.\",\"constraints\":\"Allowed values: low, medium, high\"},{\"name\":\"denoise\",\"type\":\"number\",\"required\":false,\"description\":\"Denoising level (0.0-1.0). Applies to Redefine model only.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"face_enhancement_creativity\",\"type\":\"number\",\"required\":false,\"description\":\"Creativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled.\",\"default\":\"0\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"texture\",\"type\":\"integer\",\"required\":false,\"description\":\"Texture detail level for generative upscaling (1-5). Applies to Redefine model only.\",\"constraints\":\"Range: 1 to 5\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/upscale/image/generative\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/generative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/upscale/image/generative\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/generative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/upscale/image/generative\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/generative/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/upscale/image/generative\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Upscale Image Generative" + modelId: "topaz/upscale/image/generative" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "upscale/image/generative" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:18.538Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/upscale/image/precision.md b/model-api-reference/image-generation/topaz/upscale/image/precision.md new file mode 100644 index 00000000..ee9388a6 --- /dev/null +++ b/model-api-reference/image-generation/topaz/upscale/image/precision.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Upscale Image Precision API Reference" +description: "Topaz Upscale Image Precision API reference for SandBase. Use model topaz/upscale/image/precision with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/upscale/image/precision" +apiReferenceJson: "{\"title\":\"Topaz Upscale Image Precision\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Upscale Image Precision is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/upscale/image/precision.\",\"default\":\"topaz/upscale/image/precision\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to be upscaled\"},{\"name\":\"strength\",\"type\":\"number\",\"required\":false,\"description\":\"Enhancement strength (0.01-1.0). Applies to Text Refine model only.\",\"constraints\":\"Range: 0.01 to 1\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Output format of the upscaled image.\",\"default\":\"jpeg\",\"constraints\":\"Allowed values: jpeg, png\"},{\"name\":\"denoise\",\"type\":\"number\",\"required\":false,\"description\":\"Denoising level (0.0-1.0). Default varies by model.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"face_enhancement_creativity\",\"type\":\"number\",\"required\":false,\"description\":\"Creativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled.\",\"default\":\"0\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"face_enhancement_strength\",\"type\":\"number\",\"required\":false,\"description\":\"Strength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled.\",\"default\":\"0.8\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"fix_compression\",\"type\":\"number\",\"required\":false,\"description\":\"Compression artifact removal level (0.0-1.0). Not supported by the CGI model.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"crop_to_fill\",\"type\":\"boolean\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"default\":\"false\"},{\"name\":\"upscale_factor\",\"type\":\"number\",\"required\":false,\"description\":\"Factor to upscale the image by (e.g. 2.0 doubles width and height)\",\"default\":\"2\",\"constraints\":\"Range: 1 to 4\"},{\"name\":\"face_enhancement\",\"type\":\"boolean\",\"required\":false,\"description\":\"Whether to apply face enhancement to the image.\",\"default\":\"true\"},{\"name\":\"subject_detection\",\"type\":\"string\",\"required\":false,\"description\":\"Subject detection mode for the image enhancement.\",\"default\":\"All\",\"constraints\":\"Allowed values: All, Foreground, Background\"},{\"name\":\"sharpen\",\"type\":\"number\",\"required\":false,\"description\":\"Sharpening level (0.0-1.0). Default varies by model.\",\"constraints\":\"Range: 0 to 1\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/upscale/image/precision\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/precision/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/upscale/image/precision\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/precision/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/upscale/image/precision\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/precision/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"jpeg\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/upscale/image/precision\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Upscale Image Precision" + modelId: "topaz/upscale/image/precision" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "upscale/image/precision" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:13.114Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/image-generation/topaz/upscale/image/transparent.md b/model-api-reference/image-generation/topaz/upscale/image/transparent.md new file mode 100644 index 00000000..01f68394 --- /dev/null +++ b/model-api-reference/image-generation/topaz/upscale/image/transparent.md @@ -0,0 +1,21 @@ +--- +title: "Topaz Upscale Image Transparent API Reference" +description: "Topaz Upscale Image Transparent API reference for SandBase. Use model topaz/upscale/image/transparent with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "image/topaz/upscale/image/transparent" +apiReferenceJson: "{\"title\":\"Topaz Upscale Image Transparent\",\"operation\":\"Image Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Upscale Image Transparent is Topaz Labs's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to topaz/upscale/image/transparent.\",\"default\":\"topaz/upscale/image/transparent\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Url of the image to process\"},{\"name\":\"output_format\",\"type\":\"string\",\"required\":false,\"description\":\"Transparent upscaling always outputs PNG to preserve the alpha channel.\",\"default\":\"png\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-image\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"topaz/upscale/image/transparent\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/transparent/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"topaz/upscale/image/transparent\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/transparent/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"topaz/upscale/image/transparent\\\",\\n \\\"image\\\": \\\"https://static.sandbase.ai/examples/topaz/upscale/image/transparent/input_image_0.jpeg\\\",\\n \\\"output_format\\\": \\\"png\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"topaz/upscale/image/transparent\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Topaz Upscale Image Transparent" + modelId: "topaz/upscale/image/transparent" + vendor: "Topaz Labs" + vendorSlug: "topaz" + modelSlug: "upscale/image/transparent" + protocol: "Image Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-17T19:51:26.535Z" + capabilities: ["image-to-image"] + category: "Image Generation" +--- + + diff --git a/model-api-reference/llm-models.md b/model-api-reference/llm-models.md index ec91640a..b9ce89f4 100644 --- a/model-api-reference/llm-models.md +++ b/model-api-reference/llm-models.md @@ -13,6 +13,7 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O ### OpenAI +- [GPT-6 Astra](/model-api-reference/llm-models/openai/gpt-6-astra) — GPT-6 Astra is OpenAI's flagship model for demanding end-to-end work. It is suited for advanced analysis, software engineering, deep research, scientific work, computer use, and document creation. - [GPT-5.6 Luna Pro](/model-api-reference/llm-models/openai/gpt-5.6-luna-pro) — GPT-5.6 Luna Pro is the same underlying model as GPT-5.6 Luna, served with `reasoning.mode` set to `pro` for higher-quality responses on complex tasks. - [GPT-5.6 Luna](/model-api-reference/llm-models/openai/gpt-5.6-luna) — GPT-5.6 Luna is a fast, cost-efficient model in OpenAI's GPT-5.6 series. It is suited for high-volume, latency-sensitive tasks such as chat, classification, and lightweight agentic workflows, providing capable reasoning for... - [GPT-5.6 Terra Pro](/model-api-reference/llm-models/openai/gpt-5.6-terra-pro) — GPT-5.6 Terra Pro is the same underlying model as GPT-5.6 Terra, served with `reasoning.mode` set to `pro` for higher-quality responses on complex tasks. @@ -24,11 +25,11 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [GPT-5.5](/model-api-reference/llm-models/openai/gpt-5.5) — GPT-5.5 is OpenAI’s frontier model designed for complex professional workloads, building on GPT-5.4 with stronger reasoning, higher reliability, and improved token efficiency on hard tasks. It features a 1M+ token context window (922K input, 128K output) with support for text and image inputs, enabling large-scale reasoning, coding, and multimodal workflows within a single system. - [GPT-5.4 Image 2](/model-api-reference/llm-models/openai/gpt-5.4-image-2) — GPT-5.4 Image 2 combines OpenAI's GPT-5.4 model with state-of-the-art image generation capabilities from GPT Image 2. It enables rich multimodal workflows, allowing users to seamlessly move between reasoning, coding, and visual generation within the same interaction. - [GPT-5.4 Nano](/model-api-reference/llm-models/openai/gpt-5.4-nano) — GPT-5.4 nano is the most lightweight and cost-efficient variant of the GPT-5.4 family, optimized for speed-critical and high-volume tasks. It supports text and image inputs and is designed for low-latency use cases such as classification, data extraction, ranking, and sub-agent execution. -- [GPT-5.4 Mini](/model-api-reference/llm-models/openai/gpt-5.4-mini) — GPT-5.4 mini brings the core capabilities of GPT-5.4 to a faster, more efficient model optimized for high-throughput workloads. It supports text and image inputs with strong performance across reasoning, coding, and tool use, while reducing latency and cost for large-scale deployments. -- …and 57 more models in the sidebar. +- …and 58 more models in the sidebar. ### Anthropic +- [Claude Fable 5.1](/model-api-reference/llm-models/anthropic/claude-fable-5.1) — Claude Fable 5.1 improves on Claude Fable 5 across the board, with the biggest gains in agentic coding, long-running agentic workflows, and knowledge work: long code refactors, front-end and visual... - [Claude Opus 5](/model-api-reference/llm-models/anthropic/claude-opus-5) — Claude Opus 5 is the most powerful model in the Claude 5 family from Anthropic. It excels at complex reasoning, analysis, and creative tasks with superior accuracy and nuance. It supports text, image, and file inputs with text output, reasoning support and a 1M-token context window. - [Claude Sonnet 5](/model-api-reference/llm-models/anthropic/claude-sonnet-5) — Claude Sonnet 5 is a Sonnet-class model for high-quality coding, agentic workflows, reasoning, vision, structured outputs, and tool use. - [Claude Fable 5](/model-api-reference/llm-models/anthropic/claude-fable-5) — Claude Fable 5 is a Mythos-class model from Anthropic, built for autonomous knowledge work and coding. It supports text, image, and file inputs with text output, with reasoning support and a 1M-token context window. It is suited for long-running, complex, and asynchronous tasks that previously required frequent human check-ins. @@ -40,11 +41,11 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [Claude Sonnet 4.6](/model-api-reference/llm-models/anthropic/claude-sonnet-4.6) — Sonnet 4.6 is Anthropic's most capable Sonnet-class model yet, with frontier performance across coding, agents, and professional work. It excels at iterative development, complex codebase navigation, end-to-end project management with memory, polished document creation, and confident computer use for web QA and workflow automation. - [Claude Opus 4.6](/model-api-reference/llm-models/anthropic/claude-opus-4.6) — Opus 4.6 is Anthropic’s strongest model for coding and long-running professional tasks. It is built for agents that operate across entire workflows rather than single prompts, making it especially effective for large codebases, complex refactors, and multi-step debugging that unfolds over time. The model shows deeper contextual understanding, stronger problem decomposition, and greater reliability on hard engineering tasks than prior generations. - [Claude Opus 4.5](/model-api-reference/llm-models/anthropic/claude-opus-4.5) — Claude Opus 4.5 is Anthropic’s frontier reasoning model optimized for complex software engineering, agentic workflows, and long-horizon computer use. It offers strong multimodal capabilities, competitive performance across real-world coding and reasoning benchmarks, and improved robustness to prompt injection. The model is designed to operate efficiently across varied effort levels, enabling developers to trade off speed, depth, and token usage depending on task requirements. It comes with a new parameter to control token efficiency, which can be accessed using the OpenRouter Verbosity parameter with low, medium, or high. -- [Claude Haiku 4.5](/model-api-reference/llm-models/anthropic/claude-haiku-4.5) — Claude Haiku 4.5 is Anthropic’s fastest and most efficient model, delivering near-frontier intelligence at a fraction of the cost and latency of larger Claude models. Matching Claude Sonnet 4’s performance across reasoning, coding, and computer-use tasks, Haiku 4.5 brings frontier-level capability to real-time and high-volume applications. -- …and 8 more models in the sidebar. +- …and 9 more models in the sidebar. ### Google +- [Gemini 3.8 Flash](/model-api-reference/llm-models/google/gemini-3.8-flash) — Gemini 3.8 Flash is Google's most intelligent Flash model with significant gains from 3.7 Flash across software engineering, agentic tasks, and multi-step reasoning. - [Gemini 3.7 Flash](/model-api-reference/llm-models/google/gemini-3.7-flash) — Gemini 3.7 Flash is a multimodal model from Google for fast agentic workflows, coding, and complex multi-step reasoning. It is designed for responsive performance and reliable multi-step execution. - [Gemini 3.5 Flash Lite](/model-api-reference/llm-models/google/gemini-3.5-flash-lite) — Gemini 3.5 Flash Lite is a high-efficiency multimodal model from Google with upgraded agentic capabilities. It is suited for focused subagent tasks in complex multi-agent workflows. - [Gemini 3.6 Flash](/model-api-reference/llm-models/google/gemini-3.6-flash) — Gemini 3.6 Flash is a high-efficiency multimodal model from Google for coding, agentic workflows, and web and app development. It produces polished outputs with fewer unnecessary edits. @@ -60,6 +61,8 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O ### DeepSeek +- [DeepSeek V4.1 Flash](/model-api-reference/llm-models/deepseek/deepseek-v4.1-flash) — DeepSeek V4.1 Flash is a sparse mixture-of-experts model from DeepSeek, and the first built on the company's Causal Encoder-Decoder (CED) architecture. It activates 8B parameters on input and 16B on output from a 552B-parameter backbone, an asymmetric split that keeps per-token compute low relative to the model's total size. Image understanding is native to the architecture, with visual and text embeddings trained jointly from the start of pre-training rather than added afterward as in the earlier experimental V4 Flash Vision Exp. +- [DeepSeek V4 Flash Vision Exp (Experimental)](/model-api-reference/llm-models/deepseek/deepseek-v4-flash-vision-exp) — DeepSeek V4 Flash Vision Exp is an experimental multimodal understanding model that accepts mixed text and image input and produces text output. It supports OpenAI-compatible image URL and base64 data URL content parts while retaining the text, reasoning, tool-calling, and JSON-output capabilities of DeepSeek V4 Flash. - [DeepSeek V4 Flash 0731](/model-api-reference/llm-models/deepseek/deepseek-v4-flash-0731) — DeepSeek V4 Flash 0731 is a sparse mixture-of-experts model from DeepSeek, with 13B active parameters out of 284B total. This re-post-trained revision is suited for coding, reasoning, and agent workflows. - [DeepSeek V4 Pro](/model-api-reference/llm-models/deepseek/deepseek-v4-pro) — DeepSeek V4 Pro is a large-scale Mixture-of-Experts model from DeepSeek with 1.6T total parameters and 49B activated parameters, supporting a 1M-token context window. It is designed for advanced reasoning, coding, and long-horizon agent workflows, with strong performance across knowledge, math, and software engineering benchmarks. - [DeepSeek V4 Flash](/model-api-reference/llm-models/deepseek/deepseek-v4-flash) — DeepSeek V4 Flash is an efficiency-optimized Mixture-of-Experts model from DeepSeek with 284B total parameters and 13B activated parameters, supporting a 1M-token context window. It is designed for fast inference and high-throughput workloads, while maintaining strong reasoning and coding performance. @@ -70,12 +73,11 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [DeepSeek V3.1](/model-api-reference/llm-models/deepseek/deepseek-chat-v3.1) — DeepSeek-V3.1 is a large hybrid reasoning model (671B parameters, 37B active) that supports both thinking and non-thinking modes via prompt templates. It extends the DeepSeek-V3 base with a two-phase long-context training process, reaching up to 128K tokens, and uses FP8 microscaling for efficient inference. Users can control the reasoning behaviour with the `reasoning` `enabled` boolean. Learn more in our docs - [R1 0528](/model-api-reference/llm-models/deepseek/deepseek-r1-0528) — May 28th update to the original DeepSeek R1 Performance on par with OpenAI o1, but open-sourced and with fully open reasoning tokens. It's 671B parameters in size, with 37B active in an inference pass. - [DeepSeek V3 0324](/model-api-reference/llm-models/deepseek/deepseek-chat-v3-0324) — DeepSeek V3, a 685B-parameter, mixture-of-experts model, is the available iteration of the flagship chat model family from the DeepSeek team. -- [R1 Distill Qwen 32B](/model-api-reference/llm-models/deepseek/deepseek-r1-distill-qwen-32b) — DeepSeek R1 Distill Qwen 32B is a distilled large language model based on Qwen 2.5 32B, using outputs from DeepSeek R1. It outperforms OpenAI's o1-mini across various benchmarks, achieving new state-of-the-art results for dense models.\n\nOther benchmark results include:\n\n- AIME 2024 pass@1: 72.6\n- MATH-500 pass@1: 94.3\n- CodeForces Rating: 1691\n\nThe model leverages fine-tuning from DeepSeek R1's outputs, enabling competitive performance comparable to larger frontier models. -- [R1 Distill Llama 70B](/model-api-reference/llm-models/deepseek/deepseek-r1-distill-llama-70b) — DeepSeek R1 Distill Llama 70B is a distilled large language model based on Llama-3.3-70B-Instruct, using outputs from DeepSeek R1. The model combines advanced distillation techniques to achieve high performance across multiple benchmarks, including: -- …and 2 more models in the sidebar. +- …and 4 more models in the sidebar. ### Alibaba +- [Qwen: Qwen3.8 27B](/model-api-reference/llm-models/alibaba/qwen3.8-27b) — The Qwen3.8 27B native vision-language dense model builds upon the 3.6-27B version, with key improvements in coding and office productivity capabilities across both text and visual modalities. It enables more reliable end-to-end completion of complex tasks, delivering consistently trustworthy results. - [Qwen: Qwen3.8 2.4T A95B](/model-api-reference/llm-models/alibaba/qwen3.8-2.4t-a95b) — Qwen3.8 2.4T A95B is an open-weight sparse mixture-of-experts model from Qwen, with 95 billion active parameters out of 2.4 trillion total. It is the open-weight variant of Qwen3.8 Max. - [Qwen: Qwen3.8 Max](/model-api-reference/llm-models/alibaba/qwen3.8-max) — Qwen3.8 Max is the flagship model in Alibaba's Qwen3.8 series and the general-availability successor to Qwen3.8 Max Preview. It is a multimodal reasoning model intended for complex reasoning and visual understanding. - [Qwen: Qwen3.7 Plus](/model-api-reference/llm-models/alibaba/qwen3.7-plus) — Qwen3.7-Plus is a cost-effective model in Alibaba's Qwen3.7 series. It supports text and image input with text output, building on the series' text capabilities with a comprehensive upgrade to its... @@ -87,8 +89,7 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [Qwen: Qwen3.6 27B](/model-api-reference/llm-models/alibaba/qwen3.6-27b) — Qwen3.6 27B is a dense 27-billion-parameter language model from the Qwen Team at Alibaba, released in April 2026. It features hybrid multimodal capabilities — accepting text, image, and video inputs... - [Qwen: Qwen3.6 Plus](/model-api-reference/llm-models/alibaba/qwen3.6-plus) — Qwen 3.6 Plus builds on a hybrid architecture that combines efficient linear attention with sparse mixture-of-experts routing, enabling strong scalability and high-performance inference. Compared to the 3.5 series, it delivers... - [Qwen: Qwen3.5-9B](/model-api-reference/llm-models/alibaba/qwen3.5-9b) — Qwen3.5-9B is a multimodal foundation model from the Qwen3.5 family, designed to deliver strong reasoning, coding, and visual understanding in an efficient 9B-parameter architecture. It uses a unified vision-language design... -- [Qwen: Qwen3.5-35B-A3B](/model-api-reference/llm-models/alibaba/qwen3.5-35b-a3b) — The Qwen3.5 Series 35B-A3B is a native vision-language model designed with a hybrid architecture that integrates linear attention mechanisms and a sparse mixture-of-experts model, achieving higher inference efficiency. Its overall... -- …and 42 more models in the sidebar. +- …and 43 more models in the sidebar. ### Meta @@ -368,6 +369,7 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O ### Tencent +- [Hy4 preview](/model-api-reference/llm-models/tencent/hy4-preview) — Tencent: Hy4 preview is a mixture-of-experts model from Tencent, with 49B active parameters out of 770B total. It is designed for coding agents, complex tool-use workflows, and productivity tasks that... - [Hy3](/model-api-reference/llm-models/tencent/hy3) — Hy3 is a 295B-parameter Mixture-of-Experts model from Tencent (21B active, 192 experts with top-8 routing) built for reasoning, agentic workflows, and real-world production use. It supports configurable reasoning effort. - [Hy3 preview](/model-api-reference/llm-models/tencent/hy3-preview) — Hy3 preview is a high-efficiency Mixture-of-Experts model from Tencent designed for agentic workflows and production use. It supports configurable reasoning levels across disabled, low, and high modes, allowing it to balance speed and depth depending on the task, while delivering strong code generation and reliable performance across multi-step, real-world workflows. - [Hunyuan A13B Instruct](/model-api-reference/llm-models/tencent/hunyuan-a13b-instruct) — Hunyuan-A13B is a 13B active parameter Mixture-of-Experts (MoE) language model developed by Tencent, with a total parameter count of 80B and support for reasoning via Chain-of-Thought. It offers competitive benchmark performance across mathematics, science, coding, and multi-turn reasoning tasks, while maintaining high inference efficiency via Grouped Query Attention (GQA) and quantization support (FP8, GPTQ, etc.). @@ -379,12 +381,17 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [TheDrummer: UnslopNemo 12B](/model-api-reference/llm-models/thedrummer/unslopnemo-12b) — UnslopNemo v4.1 is the available addition from the creator of Rocinante, designed for adventure writing and role-play scenarios. - [TheDrummer: Rocinante 12B](/model-api-reference/llm-models/thedrummer/rocinante-12b) — Rocinante 12B is designed for engaging storytelling and rich prose. +### TypeSafe + +- [Jev 1.13](/model-api-reference/llm-models/typesafe/jev-1.13) — Jev 1.13 is TypeSafe's System One model for structured decisions from state and typed questions. + ### Undi95 - [ReMM SLERP 13B](/model-api-reference/llm-models/undi95/remm-slerp-l2-13b) — A recreation trial of the original MythoMax-L2-B13 but with updated models. #merge ### Upstage +- [Solar Pro 4](/model-api-reference/llm-models/upstage/solar-pro4) — Solar Pro 4 is Upstage's cost-efficient large language model, featuring a 524K context window. It is built for long-horizon tasks and agentic workflows, with strong capabilities in office productivity, document-intensive... - [Solar Pro 3](/model-api-reference/llm-models/upstage/solar-pro-3) — Solar Pro 3 is Upstage's powerful Mixture-of-Experts (MoE) language model. With 102B total parameters and 12B active parameters per forward pass, it delivers exceptional performance while maintaining computational efficiency. Optimized for Korean with English and Japanese support. ### Writer @@ -400,6 +407,7 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O ### Z-Ai +- [Z.ai: GLM 5.3](/model-api-reference/llm-models/z-ai/glm-5.3) — GLM-5.3 is a large-scale reasoning model from Z.ai, built for complex software engineering and long-horizon agent tasks. It supports text input and output with a 1M-token context window, and improves... - [Z.ai: GLM 5.2](/model-api-reference/llm-models/z-ai/glm-5.2) — GLM 5.2 is a large-scale reasoning model from Z.ai. It supports text input and output with a 1M-token context window, and is suited for long-horizon agent workflows, project-level software engineering,... - [Z.ai: GLM 5.1](/model-api-reference/llm-models/z-ai/glm-5.1) — GLM-5.1 delivers a major leap in coding capability, with particularly significant gains in handling long-horizon tasks. Unlike previous models built around minute-level interactions, GLM-5.1 can work independently and continuously on a single task for more than 8 hours, autonomously planning, executing, and improving itself throughout the process, ultimately delivering complete, engineering-grade results. - [Z.ai: GLM 5V Turbo](/model-api-reference/llm-models/z-ai/glm-5v-turbo) — GLM-5V-Turbo is Z.ai’s first native multimodal agent foundation model, built for vision-based coding and agent-driven tasks. It natively handles image, video, and text inputs, excels at long-horizon planning, complex coding, and task execution, and works seamlessly with agents to complete the full loop of “perceive → plan → execute“. @@ -411,9 +419,8 @@ Claude / Anthropic models use the SandBase-compatible `/v1/messages` protocol. O - [Z.ai: GLM 4.6](/model-api-reference/llm-models/z-ai/glm-4.6) — Compared with GLM-4.5, this generation brings several key improvements: - [Z.ai: GLM 4.5V](/model-api-reference/llm-models/z-ai/glm-4.5v) — GLM-4.5V is a vision-language foundation model for multimodal agent applications. Built on a Mixture-of-Experts (MoE) architecture with 106B parameters and 12B activated parameters, it achieves state-of-the-art results in video understanding, image Q&A, OCR, and document parsing, with strong gains in front-end web coding, grounding, and spatial reasoning. It offers a hybrid inference mode: a "thinking mode" for deep reasoning and a "non-thinking mode" for fast responses. Reasoning behavior can be toggled via the `reasoning` `enabled` boolean. Learn more in our docs - [Z.ai: GLM 4.5](/model-api-reference/llm-models/z-ai/glm-4.5) — GLM-4.5 is our available flagship foundation model, purpose-built for agent-based applications. It leverages a Mixture-of-Experts (MoE) architecture and supports a context length of up to 128k tokens. GLM-4.5 delivers significantly enhanced capabilities in reasoning, code generation, and agent alignment. It supports a hybrid inference mode with two options, a "thinking mode" designed for complex reasoning and tool use, and a "non-thinking mode" optimized for instant responses. Users can control the reasoning behaviour with the `reasoning` `enabled` boolean. Learn more in our docs -- [Z.ai: GLM 4.5 Air](/model-api-reference/llm-models/z-ai/glm-4.5-air) — GLM-4.5-Air is the lightweight variant of our available flagship model family, also purpose-built for agent-centric applications. Like GLM-4.5, it adopts the Mixture-of-Experts (MoE) architecture but with a more compact parameter size. GLM-4.5-Air also supports hybrid inference modes, offering a "thinking mode" for advanced reasoning and tool use, and a "non-thinking mode" for real-time interaction. Users can control the reasoning behaviour with the `reasoning` `enabled` boolean. Learn more in our docs -- …and 1 more models in the sidebar. +- …and 2 more models in the sidebar. ## Capability coverage -`audio_input`, `chat`, `function_calling`, `reasoning`, `structured_output`, `vision` +`audio_input`, `chat`, `decisions`, `function_calling`, `reasoning`, `structured_output`, `vision` diff --git a/model-api-reference/llm-models/alibaba/qwen3.8-27b.md b/model-api-reference/llm-models/alibaba/qwen3.8-27b.md new file mode 100644 index 00000000..7885d09d --- /dev/null +++ b/model-api-reference/llm-models/alibaba/qwen3.8-27b.md @@ -0,0 +1,21 @@ +--- +title: "Qwen: Qwen3.8 27B API Reference" +description: "Qwen: Qwen3.8 27B API reference for SandBase. Use model alibaba/qwen3.8-27b with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/alibaba/qwen3.8-27b" +apiReferenceJson: "{\"title\":\"Qwen: Qwen3.8 27B\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"The Qwen3.8 27B native vision-language dense model builds upon the 3.6-27B version, with key improvements in coding and office productivity capabilities across both text and visual modalities. It enables more reliable end-to-end completion of complex tasks, delivering consistently trustworthy results.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to alibaba/qwen3.8-27b.\",\"default\":\"alibaba/qwen3.8-27b\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 131072\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"},{\"name\":\"presence_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes tokens that already appeared, encouraging the model to introduce new topics.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"frequency_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes repeated tokens, reducing repetition in the generated response.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Seed used to make sampling more reproducible when the provider supports it.\"},{\"name\":\"top_k\",\"type\":\"integer\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"constraints\":\"Minimum: 0\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, vision, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1000000 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"alibaba/qwen3.8-27b\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"alibaba/qwen3.8-27b\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Qwen: Qwen3.8 27B" + modelId: "alibaba/qwen3.8-27b" + vendor: "Alibaba" + vendorSlug: "alibaba" + modelSlug: "qwen3.8-27b" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-08-14T15:55:10Z" + capabilities: ["chat","vision","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/anthropic/claude-fable-5.1.md b/model-api-reference/llm-models/anthropic/claude-fable-5.1.md new file mode 100644 index 00000000..58f8aa3f --- /dev/null +++ b/model-api-reference/llm-models/anthropic/claude-fable-5.1.md @@ -0,0 +1,21 @@ +--- +title: "Claude Fable 5.1 API Reference" +description: "Claude Fable 5.1 API reference for SandBase. Use model anthropic/claude-fable-5.1 with /v1/messages; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/anthropic/claude-fable-5.1" +apiReferenceJson: "{\"title\":\"Claude Fable 5.1\",\"operation\":\"Anthropic Messages\",\"method\":\"POST\",\"path\":\"/v1/messages\",\"description\":\"Claude Fable 5.1 improves on Claude Fable 5 across the board, with the biggest gains in agentic coding, long-running agentic workflows, and knowledge work: long code refactors, front-end and visual...\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to anthropic/claude-fable-5.1.\",\"default\":\"anthropic/claude-fable-5.1\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 128000\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"content\",\"type\":\"array\",\"required\":true,\"description\":\"Assistant content blocks.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique message identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the message.\"},{\"name\":\"role\",\"type\":\"string\",\"required\":true,\"description\":\"Message role returned by the assistant.\"},{\"name\":\"stop_reason\",\"type\":\"string\",\"required\":false,\"description\":\"Reason generation stopped.\"},{\"name\":\"type\",\"type\":\"string\",\"required\":true,\"description\":\"Response object type.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, vision, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1000000 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/messages \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"anthropic/claude-fable-5.1\\\",\\n \\\"max_tokens\\\": 1024,\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"msg_abc123\\\",\\n \\\"type\\\": \\\"message\\\",\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"model\\\": \\\"anthropic/claude-fable-5.1\\\",\\n \\\"content\\\": [\\n {\\n \\\"type\\\": \\\"text\\\",\\n \\\"text\\\": \\\"A concise product description.\\\"\\n }\\n ],\\n \\\"stop_reason\\\": \\\"end_turn\\\"\\n}\"}}" +seo: + modelName: "Claude Fable 5.1" + modelId: "anthropic/claude-fable-5.1" + vendor: "Anthropic" + vendorSlug: "anthropic" + modelSlug: "claude-fable-5.1" + protocol: "Messages API" + endpoint: "/v1/messages" + publishedAt: "2026-09-01T18:03:58Z" + capabilities: ["chat","vision","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/deepseek/deepseek-v4-flash-vision-exp.md b/model-api-reference/llm-models/deepseek/deepseek-v4-flash-vision-exp.md new file mode 100644 index 00000000..84994d8a --- /dev/null +++ b/model-api-reference/llm-models/deepseek/deepseek-v4-flash-vision-exp.md @@ -0,0 +1,21 @@ +--- +title: "DeepSeek V4 Flash Vision Exp (Experimental) API Reference" +description: "SandBase API reference for model deepseek/deepseek-v4-flash-vision-exp. Call /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/deepseek/deepseek-v4-flash-vision-exp" +apiReferenceJson: "{\"title\":\"DeepSeek V4 Flash Vision Exp (Experimental)\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"DeepSeek V4 Flash Vision Exp is an experimental multimodal understanding model that accepts mixed text and image input and produces text output. It supports OpenAI-compatible image URL and base64 data URL content parts while retaining the text, reasoning, tool-calling, and JSON-output capabilities of DeepSeek V4 Flash.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to deepseek/deepseek-v4-flash-vision-exp.\",\"default\":\"deepseek/deepseek-v4-flash-vision-exp\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"OpenAI-compatible messages. Image parts are accepted only in user messages. Supported image formats: JPEG, PNG, GIF, and WebP. Up to 600 images are allowed per request.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 384000\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"object\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"},{\"name\":\"presence_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes tokens that already appeared, encouraging the model to introduce new topics.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"frequency_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes repeated tokens, reducing repetition in the generated response.\",\"constraints\":\"Range: -2 to 2\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, vision, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1048576 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"deepseek/deepseek-v4-flash-vision-exp\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"deepseek/deepseek-v4-flash-vision-exp\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "DeepSeek V4 Flash Vision Exp (Experimental)" + modelId: "deepseek/deepseek-v4-flash-vision-exp" + vendor: "DeepSeek" + vendorSlug: "deepseek" + modelSlug: "deepseek-v4-flash-vision-exp" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-08-21T11:26:03Z" + capabilities: ["chat","vision","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/deepseek/deepseek-v4.1-flash.md b/model-api-reference/llm-models/deepseek/deepseek-v4.1-flash.md new file mode 100644 index 00000000..6bfaee8d --- /dev/null +++ b/model-api-reference/llm-models/deepseek/deepseek-v4.1-flash.md @@ -0,0 +1,21 @@ +--- +title: "DeepSeek V4.1 Flash API Reference" +description: "DeepSeek V4.1 Flash API reference for SandBase. Use model deepseek/deepseek-v4.1-flash with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/deepseek/deepseek-v4.1-flash" +apiReferenceJson: "{\"title\":\"DeepSeek V4.1 Flash\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"DeepSeek V4.1 Flash is a sparse mixture-of-experts model from DeepSeek, and the first built on the company's Causal Encoder-Decoder (CED) architecture. It activates 8B parameters on input and 16B on output from a 552B-parameter backbone, an asymmetric split that keeps per-token compute low relative to the model's total size. Image understanding is native to the architecture, with visual and text embeddings trained jointly from the start of pre-training rather than added afterward as in the earlier experimental V4 Flash Vision Exp.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to deepseek/deepseek-v4.1-flash.\",\"default\":\"deepseek/deepseek-v4.1-flash\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 943718\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"},{\"name\":\"presence_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes tokens that already appeared, encouraging the model to introduce new topics.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"frequency_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes repeated tokens, reducing repetition in the generated response.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Seed used to make sampling more reproducible when the provider supports it.\"},{\"name\":\"top_k\",\"type\":\"integer\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"constraints\":\"Minimum: 0\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1048576 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"deepseek/deepseek-v4.1-flash\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"deepseek/deepseek-v4.1-flash\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "DeepSeek V4.1 Flash" + modelId: "deepseek/deepseek-v4.1-flash" + vendor: "DeepSeek" + vendorSlug: "deepseek" + modelSlug: "deepseek-v4.1-flash" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-09-10T06:21:25Z" + capabilities: ["chat","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/google/gemini-3.8-flash.md b/model-api-reference/llm-models/google/gemini-3.8-flash.md new file mode 100644 index 00000000..2f345492 --- /dev/null +++ b/model-api-reference/llm-models/google/gemini-3.8-flash.md @@ -0,0 +1,21 @@ +--- +title: "Gemini 3.8 Flash API Reference" +description: "Gemini 3.8 Flash API reference for SandBase. Use model google/gemini-3.8-flash with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/google/gemini-3.8-flash" +apiReferenceJson: "{\"title\":\"Gemini 3.8 Flash\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"Gemini 3.8 Flash is Google's most intelligent Flash model with significant gains from 3.7 Flash across software engineering, agentic tasks, and multi-step reasoning.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to google/gemini-3.8-flash.\",\"default\":\"google/gemini-3.8-flash\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 65536\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Seed used to make sampling more reproducible when the provider supports it.\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, vision, audio_input, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1048576 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"google/gemini-3.8-flash\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"google/gemini-3.8-flash\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Gemini 3.8 Flash" + modelId: "google/gemini-3.8-flash" + vendor: "Google" + vendorSlug: "google" + modelSlug: "gemini-3.8-flash" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-09-02T15:14:16Z" + capabilities: ["chat","vision","audio_input","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/openai/gpt-6-astra.md b/model-api-reference/llm-models/openai/gpt-6-astra.md new file mode 100644 index 00000000..420930e9 --- /dev/null +++ b/model-api-reference/llm-models/openai/gpt-6-astra.md @@ -0,0 +1,21 @@ +--- +title: "GPT-6 Astra API Reference" +description: "GPT-6 Astra API reference for SandBase. Use model openai/gpt-6-astra with /v1/responses; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/openai/gpt-6-astra" +apiReferenceJson: "{\"title\":\"GPT-6 Astra\",\"operation\":\"OpenAI Responses\",\"method\":\"POST\",\"path\":\"/v1/responses\",\"description\":\"GPT-6 Astra is OpenAI's flagship model for demanding end-to-end work. It is suited for advanced analysis, software engineering, deep research, scientific work, computer use, and document creation.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by the OpenAI Responses API. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to openai/gpt-6-astra.\",\"default\":\"openai/gpt-6-astra\"},{\"name\":\"input\",\"type\":\"string | array\",\"required\":true,\"description\":\"Input text or structured content for the response.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 128000\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Seed used to make sampling more reproducible when the provider supports it.\"},{\"name\":\"max_completion_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"constraints\":\"Maximum: 128000\"},{\"name\":\"reasoning_effort\",\"type\":\"string\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"default\":\"medium\",\"constraints\":\"Allowed values: low, medium, high, xhigh, max\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by the OpenAI Responses API.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique response identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"object\",\"type\":\"string\",\"required\":true,\"description\":\"Response object type.\"},{\"name\":\"output\",\"type\":\"array\",\"required\":true,\"description\":\"Generated response output items.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Response lifecycle status.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, vision, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1050000 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/responses \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"openai/gpt-6-astra\\\",\\n \\\"input\\\": \\\"Describe this product in one sentence.\\\"\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"resp_abc123\\\",\\n \\\"object\\\": \\\"response\\\",\\n \\\"status\\\": \\\"completed\\\",\\n \\\"model\\\": \\\"openai/gpt-6-astra\\\",\\n \\\"output\\\": [\\n {\\n \\\"type\\\": \\\"message\\\",\\n \\\"content\\\": [\\n {\\n \\\"type\\\": \\\"output_text\\\",\\n \\\"text\\\": \\\"A concise product description.\\\"\\n }\\n ]\\n }\\n ]\\n}\"}}" +seo: + modelName: "GPT-6 Astra" + modelId: "openai/gpt-6-astra" + vendor: "OpenAI" + vendorSlug: "openai" + modelSlug: "gpt-6-astra" + protocol: "Responses API" + endpoint: "/v1/responses" + publishedAt: "2026-09-04T20:13:58Z" + capabilities: ["chat","vision","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/tencent/hy4-preview.md b/model-api-reference/llm-models/tencent/hy4-preview.md new file mode 100644 index 00000000..8a84543e --- /dev/null +++ b/model-api-reference/llm-models/tencent/hy4-preview.md @@ -0,0 +1,21 @@ +--- +title: "Hy4 preview API Reference" +description: "Hy4 preview API reference for SandBase. Use model tencent/hy4-preview with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/tencent/hy4-preview" +apiReferenceJson: "{\"title\":\"Hy4 preview\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"Tencent: Hy4 preview is a mixture-of-experts model from Tencent, with 49B active parameters out of 770B total. It is designed for coding agents, complex tool-use workflows, and productivity tasks that...\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to tencent/hy4-preview.\",\"default\":\"tencent/hy4-preview\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 64000\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"stop\",\"type\":\"array\",\"required\":false,\"description\":\"Sequences that stop generation when the model produces one of them.\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1048576 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"tencent/hy4-preview\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"tencent/hy4-preview\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Hy4 preview" + modelId: "tencent/hy4-preview" + vendor: "Tencent" + vendorSlug: "tencent" + modelSlug: "hy4-preview" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-08-28T06:09:35Z" + capabilities: ["chat","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/typesafe/jev-1.13.md b/model-api-reference/llm-models/typesafe/jev-1.13.md new file mode 100644 index 00000000..a83dcc08 --- /dev/null +++ b/model-api-reference/llm-models/typesafe/jev-1.13.md @@ -0,0 +1,21 @@ +--- +title: "Jev 1.13 API Reference" +description: "Jev 1.13 API reference for SandBase. Use model typesafe/jev-1.13 with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/typesafe/jev-1.13" +apiReferenceJson: "{\"title\":\"Jev 1.13\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"Jev 1.13 is TypeSafe's System One model for structured decisions from state and typed questions.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to typesafe/jev-1.13.\",\"default\":\"typesafe/jev-1.13\"},{\"name\":\"questions\",\"type\":\"object\",\"required\":true,\"description\":\"Typed questions evaluated against state.\"},{\"name\":\"state\",\"type\":\"object\",\"required\":true,\"description\":\"State passed to the System One model. The upstream accepts the native TypeSafe state shape.\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"decisions\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"32000 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"typesafe/jev-1.13\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"typesafe/jev-1.13\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Jev 1.13" + modelId: "typesafe/jev-1.13" + vendor: "TypeSafe" + vendorSlug: "typesafe" + modelSlug: "jev-1.13" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-09-18T00:01:24Z" + capabilities: ["decisions"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/upstage/solar-pro4.md b/model-api-reference/llm-models/upstage/solar-pro4.md new file mode 100644 index 00000000..bf2436fe --- /dev/null +++ b/model-api-reference/llm-models/upstage/solar-pro4.md @@ -0,0 +1,21 @@ +--- +title: "Solar Pro 4 API Reference" +description: "Solar Pro 4 API reference for SandBase. Use model upstage/solar-pro4 with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/upstage/solar-pro4" +apiReferenceJson: "{\"title\":\"Solar Pro 4\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"Solar Pro 4 is Upstage's cost-efficient large language model, featuring a 524K context window. It is built for long-horizon tasks and agentic workflows, with strong capabilities in office productivity, document-intensive...\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to upstage/solar-pro4.\",\"default\":\"upstage/solar-pro4\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 131072\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"presence_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes tokens that already appeared, encouraging the model to introduce new topics.\",\"constraints\":\"Range: -2 to 2\"},{\"name\":\"frequency_penalty\",\"type\":\"number\",\"required\":false,\"description\":\"Penalizes repeated tokens, reducing repetition in the generated response.\",\"constraints\":\"Range: -2 to 2\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"524288 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"upstage/solar-pro4\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"upstage/solar-pro4\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Solar Pro 4" + modelId: "upstage/solar-pro4" + vendor: "Upstage" + vendorSlug: "upstage" + modelSlug: "solar-pro4" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-08-10T14:20:36Z" + capabilities: ["chat","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/llm-models/z-ai/glm-5.3.md b/model-api-reference/llm-models/z-ai/glm-5.3.md new file mode 100644 index 00000000..85d0bcd2 --- /dev/null +++ b/model-api-reference/llm-models/z-ai/glm-5.3.md @@ -0,0 +1,21 @@ +--- +title: "Z.ai: GLM 5.3 API Reference" +description: "Z.ai: GLM 5.3 API reference for SandBase. Use model z-ai/glm-5.3 with /v1/chat/completions; see request and response examples." +aside: false +outline: false +apiReferenceKey: "llm/z-ai/glm-5.3" +apiReferenceJson: "{\"title\":\"Z.ai: GLM 5.3\",\"operation\":\"Chat Completions\",\"method\":\"POST\",\"path\":\"/v1/chat/completions\",\"description\":\"GLM-5.3 is a large-scale reasoning model from Z.ai, built for complex software engineering and long-horizon agent tasks. It supports text input and output with a 1M-token context window, and improves...\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Parameters supported by this model. Values, defaults, and limits are read from the model registry.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to z-ai/glm-5.3.\",\"default\":\"z-ai/glm-5.3\"},{\"name\":\"messages\",\"type\":\"array\",\"required\":true,\"description\":\"Conversation messages in system, user, or assistant order.\"},{\"name\":\"max_tokens\",\"type\":\"integer\",\"required\":false,\"description\":\"Maximum number of tokens the model may generate in the response.\",\"constraints\":\"Maximum: 131072\"},{\"name\":\"temperature\",\"type\":\"number\",\"required\":false,\"description\":\"Sampling temperature. Lower values are more deterministic; higher values are more creative.\",\"default\":\"1\",\"constraints\":\"Range: 0 to 2\"},{\"name\":\"top_p\",\"type\":\"number\",\"required\":false,\"description\":\"Nucleus sampling threshold. Use this or temperature, but usually not both.\",\"constraints\":\"Range: 0 to 1\"},{\"name\":\"stream\",\"type\":\"boolean\",\"required\":false,\"description\":\"When true, returns incremental Server-Sent Events instead of one completed response.\",\"default\":\"false\"},{\"name\":\"tools\",\"type\":\"array\",\"required\":false,\"description\":\"Tool definitions that the model may call during the response.\"},{\"name\":\"tool_choice\",\"type\":\"string\",\"required\":false,\"description\":\"Controls whether the model may call a tool and, when supported, which tool it must call.\"},{\"name\":\"response_format\",\"type\":\"object\",\"required\":false,\"description\":\"Controls the response format, including JSON mode or structured JSON output when supported.\"},{\"name\":\"top_k\",\"type\":\"integer\",\"required\":false,\"description\":\"Request parameter supported by this model.\",\"constraints\":\"Minimum: 0\"}]},{\"title\":\"Response Schema\",\"description\":\"Fields returned by this model API response.\",\"fields\":[{\"name\":\"choices\",\"type\":\"array\",\"required\":true,\"description\":\"Generated completion choices.\"},{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Unique chat completion identifier.\"},{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model that generated the response.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Token usage when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"chat, reasoning, structured_output, function_calling\"},{\"name\":\"context_length\",\"type\":\"integer\",\"required\":true,\"description\":\"Maximum context window accepted by this model.\",\"default\":\"1048576 tokens\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"sync\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"curl -X POST https://api.sandbase.ai/v1/chat/completions \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"z-ai/glm-5.3\\\",\\n \\\"messages\\\": [\\n {\\n \\\"role\\\": \\\"user\\\",\\n \\\"content\\\": \\\"Describe this product in one sentence.\\\"\\n }\\n ]\\n}'\"}],\"response\":{\"status\":\"200 OK\",\"code\":\"{\\n \\\"id\\\": \\\"chatcmpl_abc123\\\",\\n \\\"model\\\": \\\"z-ai/glm-5.3\\\",\\n \\\"choices\\\": [\\n {\\n \\\"message\\\": {\\n \\\"role\\\": \\\"assistant\\\",\\n \\\"content\\\": \\\"A concise product description.\\\"\\n }\\n }\\n ]\\n}\"}}" +seo: + modelName: "Z.ai: GLM 5.3" + modelId: "z-ai/glm-5.3" + vendor: "Z-Ai" + vendorSlug: "z-ai" + modelSlug: "glm-5.3" + protocol: "Chat Completions API" + endpoint: "/v1/chat/completions" + publishedAt: "2026-08-18T20:57:35Z" + capabilities: ["chat","reasoning","structured_output","function_calling"] + category: "LLM Models" +--- + + diff --git a/model-api-reference/video-generation.md b/model-api-reference/video-generation.md index 614450d2..fe6313de 100644 --- a/model-api-reference/video-generation.md +++ b/model-api-reference/video-generation.md @@ -72,6 +72,9 @@ Video Generation models use the SandBase generation protocol declared in each mo ### MiniMax +- [H3 Max Reference to Video](/model-api-reference/video-generation/minimax/h3-max/reference-to-video) — H3 Max is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output. +- [H3 Max Image to Video](/model-api-reference/video-generation/minimax/h3-max/image-to-video) — H3 Max is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output. +- [MiniMax H3 Max Text to Video](/model-api-reference/video-generation/minimax/h3-max/text-to-video) — H3 Max by MiniMax - generate cinematic videos from text descriptions with AI. Create high-quality video content with natural motion, camera control, and optional audio generation. - [MiniMax H3 Video Regeneration](/model-api-reference/video-generation/minimax/h3/video-regeneration) — Regenerate a single base video from a text prompt as a 2K MiniMax H3 video. - [MiniMax H3 (Text to Video)](/model-api-reference/video-generation/minimax/h3/text-to-video) — Generate native-stereo 2K video from text with MiniMax H3. - [MiniMax H3 (Image to Video)](/model-api-reference/video-generation/minimax/h3/image-to-video) — Generate native-stereo 2K video from a first frame and optional last frame with MiniMax H3. @@ -81,10 +84,7 @@ Video Generation models use the SandBase generation protocol declared in each mo - [MiniMax Hailuo 2.3 [Standard] (Image to Video)](/model-api-reference/video-generation/minimax/hailuo/2.3/standard/image-to-video) — Hailuo 2.3 Standard by MiniMax - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion, camera movement, and optional audio generation. - [MiniMax Hailuo 2.3 Fast [Pro] (Image to Video)](/model-api-reference/video-generation/minimax/hailuo/2.3-fast/pro/image-to-video) — Hailuo 2.3 Fast Pro by MiniMax - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion, camera movement, and optional audio generation. - [MiniMax Hailuo 2.3 [Standard] (Text to Video)](/model-api-reference/video-generation/minimax/hailuo/2.3/standard/text-to-video) — Hailuo 2.3 Standard is MiniMax's text-to-video AI model. Turn written scripts and prompts into professional-quality video clips with realistic motion, lighting, and scene composition. -- [MiniMax Hailuo 2.3 [Pro] (Text to Video)](/model-api-reference/video-generation/minimax/hailuo/2.3/pro/text-to-video) — Hailuo 2.3 Pro by MiniMax - generate cinematic videos from text descriptions with AI. Create high-quality video content with natural motion, camera control, and optional audio generation. -- [MiniMax Hailuo 02 Fast (Image to Video)](/model-api-reference/video-generation/minimax/hailuo/02-fast/image-to-video) — Hailuo 02 Fast is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output. -- [MiniMax Hailuo 02 [Standard] (Image to Video)](/model-api-reference/video-generation/minimax/hailuo/02/standard/image-to-video) — Hailuo 02 Standard is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output. -- …and 10 more models in the sidebar. +- …and 13 more models in the sidebar. ### Pika @@ -114,6 +114,8 @@ Video Generation models use the SandBase generation protocol declared in each mo ### Alibaba +- [Wan 3.0 Prime](/model-api-reference/video-generation/alibaba/wan/3.0/prime/video) — Wan 3.0 Prime by Alibaba - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion and camera movement. +- [Wan 3.0 Video](/model-api-reference/video-generation/alibaba/wan/3.0/video) — Alibaba Wan 3.0 Video generates videos up to 30 seconds from text and unified image, video, audio, file, or link media inputs. - [Happy Horse 1.1 Image to Video](/model-api-reference/video-generation/alibaba/happy-horse/1.1/image-to-video) — Happy Horse 1.1 by Alibaba - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion, camera movement, and optional audio generation. - [Happy Horse 1.1 Reference to Video](/model-api-reference/video-generation/alibaba/happy-horse/1.1/reference-to-video) — Happy Horse 1.1 by Alibaba - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion, camera movement, and optional audio generation. - [Happy Horse 1.1 Text to Video](/model-api-reference/video-generation/alibaba/happy-horse/1.1/text-to-video) — Happy Horse 1.1 is Alibaba's text-to-video AI model. Turn written scripts and prompts into professional-quality video clips with realistic motion, lighting, and scene composition. @@ -124,9 +126,7 @@ Video Generation models use the SandBase generation protocol declared in each mo - [Wan 2.7 Text to Video](/model-api-reference/video-generation/alibaba/wan/2.7/text-to-video) — Alibaba Wan 2.7 text-to-video model with cinematic visuals, native audio generation, and configurable duration and resolution. - [Wan 2.7 Reference to Video](/model-api-reference/video-generation/alibaba/wan/2.7/reference-to-video) — Alibaba Wan 2.7 reference-to-video model generating video guided by reference content. - [Wan 2.7 Edit Video](/model-api-reference/video-generation/alibaba/wan/2.7/edit-video) — Alibaba Wan 2.7 video editing model. -- [Wan 2.7 Image to Video](/model-api-reference/video-generation/alibaba/wan/2.7/image-to-video) — Alibaba Wan 2.7 image-to-video model transforming still images into video with native audio generation. -- [Wan Motion](/model-api-reference/video-generation/alibaba/wan/motion) — Wan Motion by Alibaba - AI-powered video editing and transformation. Apply style transfer, motion control, lip-sync, and visual effects to existing videos with natural language instructions. -- …and 50 more models in the sidebar. +- …and 52 more models in the sidebar. ### Bria diff --git a/model-api-reference/video-generation/alibaba/wan/3.0/prime/video.md b/model-api-reference/video-generation/alibaba/wan/3.0/prime/video.md new file mode 100644 index 00000000..5b7bad8a --- /dev/null +++ b/model-api-reference/video-generation/alibaba/wan/3.0/prime/video.md @@ -0,0 +1,21 @@ +--- +title: "Wan 3.0 Prime API Reference" +description: "Wan 3.0 Prime API reference for SandBase. Use model alibaba/wan/3.0/prime/video with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "video/alibaba/wan/3.0/prime/video" +apiReferenceJson: "{\"title\":\"Wan 3.0 Prime\",\"operation\":\"Video Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Wan 3.0 Prime by Alibaba - animate still images into dynamic videos with AI. Transform photos into cinematic clips with natural motion and camera movement.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to alibaba/wan/3.0/prime/video.\",\"default\":\"alibaba/wan/3.0/prime/video\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt describing the motion to generate.\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"Output video resolution tier.\",\"default\":\"1080p\",\"constraints\":\"Allowed values: 480p, 720p, 1080p\"},{\"name\":\"duration\",\"type\":\"integer\",\"required\":false,\"description\":\"Output duration in seconds. Set to null for smart duration, which lets the model pick a length from the prompt and reference media.\",\"default\":\"5\",\"constraints\":\"Range: 2 to 30\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"constraints\":\"Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Seed used to make sampling more reproducible when the provider supports it.\",\"constraints\":\"Range: 0 to 2147483647\"},{\"name\":\"media\",\"type\":\"array\",\"required\":true,\"description\":\"Request parameter supported by this model.\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-video\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"alibaba/wan/3.0/prime/video\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"21:9\\\"\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"alibaba/wan/3.0/prime/video\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"21:9\\\"\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"alibaba/wan/3.0/prime/video\\\",\\n \\\"prompt\\\": \\\"A cinematic product photo of a matte black smart speaker on a marble table, soft studio lighting\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"21:9\\\"\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"alibaba/wan/3.0/prime/video\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Wan 3.0 Prime" + modelId: "alibaba/wan/3.0/prime/video" + vendor: "Alibaba" + vendorSlug: "alibaba" + modelSlug: "wan/3.0/prime/video" + protocol: "Video Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-24T06:03:16.474Z" + capabilities: ["image-to-video"] + category: "Video Generation" +--- + + diff --git a/model-api-reference/video-generation/alibaba/wan/3.0/video.md b/model-api-reference/video-generation/alibaba/wan/3.0/video.md new file mode 100644 index 00000000..e2cb027a --- /dev/null +++ b/model-api-reference/video-generation/alibaba/wan/3.0/video.md @@ -0,0 +1,21 @@ +--- +title: "Wan 3.0 Video API Reference" +description: "Wan 3.0 Video API reference for SandBase. Use model alibaba/wan/3.0/video with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "video/alibaba/wan/3.0/video" +apiReferenceJson: "{\"title\":\"Wan 3.0 Video\",\"operation\":\"Video Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"Alibaba Wan 3.0 Video generates videos up to 30 seconds from text and unified image, video, audio, file, or link media inputs.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to alibaba/wan/3.0/video.\",\"default\":\"alibaba/wan/3.0/video\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text instruction for the generated video.\",\"default\":\"A cinematic tracking shot of a sailboat crossing a glowing sea at sunset\"},{\"name\":\"media\",\"type\":\"array\",\"required\":false,\"description\":\"Optional unified media inputs. Alibaba accepts prompt or media; prompt remains required in this schema for compatibility.\"},{\"name\":\"duration\",\"type\":\"integer\",\"required\":false,\"description\":\"Output duration in seconds, from 2 to 30 seconds.\",\"default\":\"5\",\"constraints\":\"Range: 2 to 30\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"Output ratio; adaptive lets the model choose from the inputs.\",\"default\":\"adaptive\",\"constraints\":\"Allowed values: adaptive, 16:9, 9:16, 1:1, 4:3, 3:4\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"Output video resolution.\",\"default\":\"720p\",\"constraints\":\"Allowed values: 480p, 720p, 1080p\"},{\"name\":\"audio\",\"type\":\"boolean\",\"required\":false,\"description\":\"Generate synchronized audio with the video.\",\"default\":\"true\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Random seed for reproducible generation.\",\"constraints\":\"Range: 0 to 2147483647\"},{\"name\":\"watermark\",\"type\":\"boolean\",\"required\":false,\"description\":\"Add an Alibaba watermark to the output.\",\"default\":\"false\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"text-to-video, image-to-video, video-to-video, audio-to-video\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"alibaba/wan/3.0/video\\\",\\n \\\"prompt\\\": \\\"A cinematic tracking shot of a sailboat crossing a glowing sea at sunset\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"adaptive\\\",\\n \\\"audio\\\": true\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"alibaba/wan/3.0/video\\\",\\n \\\"prompt\\\": \\\"A cinematic tracking shot of a sailboat crossing a glowing sea at sunset\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"adaptive\\\",\\n \\\"audio\\\": True\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"alibaba/wan/3.0/video\\\",\\n \\\"prompt\\\": \\\"A cinematic tracking shot of a sailboat crossing a glowing sea at sunset\\\",\\n \\\"duration\\\": 5,\\n \\\"aspect_ratio\\\": \\\"adaptive\\\",\\n \\\"audio\\\": true\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"alibaba/wan/3.0/video\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "Wan 3.0 Video" + modelId: "alibaba/wan/3.0/video" + vendor: "Alibaba" + vendorSlug: "alibaba" + modelSlug: "wan/3.0/video" + protocol: "Video Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-20T00:00:00Z" + capabilities: ["text-to-video","image-to-video","video-to-video","audio-to-video"] + category: "Video Generation" +--- + + diff --git a/model-api-reference/video-generation/minimax/h3-max/image-to-video.md b/model-api-reference/video-generation/minimax/h3-max/image-to-video.md new file mode 100644 index 00000000..4a1266eb --- /dev/null +++ b/model-api-reference/video-generation/minimax/h3-max/image-to-video.md @@ -0,0 +1,21 @@ +--- +title: "H3 Max Image to Video API Reference" +description: "H3 Max Image to Video API reference for SandBase. Use model minimax/h3-max/image-to-video with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "video/minimax/h3-max/image-to-video" +apiReferenceJson: "{\"title\":\"H3 Max Image to Video\",\"operation\":\"Video Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"H3 Max is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to minimax/h3-max/image-to-video.\",\"default\":\"minimax/h3-max/image-to-video\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt for video generation\"},{\"name\":\"image\",\"type\":\"string\",\"required\":true,\"description\":\"Optional URL of the image to use as the first frame. When provided, the output aspect ratio follows this image. When omitted, the request is handled as text-to-video (16:9 by default).\"},{\"name\":\"end_image\",\"type\":\"string\",\"required\":false,\"description\":\"Optional URL of the image to use as the last frame, for first-to-last keyframe generation.\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The native generation resolution of the video.\",\"default\":\"768P\",\"constraints\":\"Allowed values: 480P, 768P\"},{\"name\":\"duration\",\"type\":\"integer\",\"required\":false,\"description\":\"The duration of the video in seconds.\",\"default\":\"5\",\"constraints\":\"Range: 5 to 15\"},{\"name\":\"prompt_expansion_mode\",\"type\":\"string\",\"required\":false,\"description\":\"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.\",\"default\":\"balanced\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Random seed. A random seed is selected when omitted.\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-video\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"minimax/h3-max/image-to-video\\\",\\n \\\"prompt\\\": \\\"The camera slowly pulls back from the scene, revealing the full landscape as clouds drift overhead and light shifts across the terrain.\\\",\\n \\\"image\\\": \\\"https://storage.googleapis.com/falserverless/example_inputs/hailuo23/pro_i2v_in.jpg\\\",\\n \\\"duration\\\": 5\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"minimax/h3-max/image-to-video\\\",\\n \\\"prompt\\\": \\\"The camera slowly pulls back from the scene, revealing the full landscape as clouds drift overhead and light shifts across the terrain.\\\",\\n \\\"image\\\": \\\"https://storage.googleapis.com/Falserverless/example_inputs/hailuo23/pro_i2v_in.jpg\\\",\\n \\\"duration\\\": 5\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"minimax/h3-max/image-to-video\\\",\\n \\\"prompt\\\": \\\"The camera slowly pulls back from the scene, revealing the full landscape as clouds drift overhead and light shifts across the terrain.\\\",\\n \\\"image\\\": \\\"https://storage.googleapis.com/falserverless/example_inputs/hailuo23/pro_i2v_in.jpg\\\",\\n \\\"duration\\\": 5\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"minimax/h3-max/image-to-video\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "H3 Max Image to Video" + modelId: "minimax/h3-max/image-to-video" + vendor: "MiniMax" + vendorSlug: "minimax" + modelSlug: "h3-max/image-to-video" + protocol: "Video Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-26T20:25:10.052Z" + capabilities: ["image-to-video"] + category: "Video Generation" +--- + + diff --git a/model-api-reference/video-generation/minimax/h3-max/reference-to-video.md b/model-api-reference/video-generation/minimax/h3-max/reference-to-video.md new file mode 100644 index 00000000..8cc6fbc1 --- /dev/null +++ b/model-api-reference/video-generation/minimax/h3-max/reference-to-video.md @@ -0,0 +1,21 @@ +--- +title: "H3 Max Reference to Video API Reference" +description: "H3 Max Reference to Video API reference for SandBase. Use model minimax/h3-max/reference-to-video with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "video/minimax/h3-max/reference-to-video" +apiReferenceJson: "{\"title\":\"H3 Max Reference to Video\",\"operation\":\"Video Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"H3 Max is MiniMax's image-to-video AI model. Bring static images to life with fluid animation, consistent character motion, and professional-grade video output.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to minimax/h3-max/reference-to-video.\",\"default\":\"minimax/h3-max/reference-to-video\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt for video generation. Refer to reference assets by their modality and order in the reference lists: Image 1, Image 2, Video 1, Audio 1, and so on.\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"constraints\":\"Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The native generation resolution of the video.\",\"default\":\"768P\",\"constraints\":\"Allowed values: 480P, 768P\"},{\"name\":\"duration\",\"type\":\"integer\",\"required\":false,\"description\":\"The duration of the video in seconds.\",\"default\":\"5\",\"constraints\":\"Range: 5 to 15\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Random seed. A random seed is selected when omitted.\"},{\"name\":\"reference_image_urls\",\"type\":\"array\",\"required\":false,\"description\":\"URLs of subject/style reference images, referenced in the prompt as Image 1, Image 2, and so on. Reference images, videos, and audio clips must add up to at most 12 files.\"},{\"name\":\"prompt_expansion_mode\",\"type\":\"string\",\"required\":false,\"description\":\"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.\",\"default\":\"balanced\"},{\"name\":\"reference_video_urls\",\"type\":\"array\",\"required\":false,\"description\":\"URLs of motion/reference video clips (2-15 seconds each, combined duration at most 15 seconds), referenced in the prompt as Video 1, Video 2, and so on. Reference images, videos, and audio clips must add up to at most 12 files.\"},{\"name\":\"reference_audio_urls\",\"type\":\"array\",\"required\":false,\"description\":\"URLs of reference audio clips (2-15 seconds each, combined duration at most 15 seconds), referenced in the prompt as Audio 1, Audio 2, and so on. Audio cannot be the only reference input; provide at least one reference image or video with it. Reference images, videos, and audio clips must add up to at most 12 files.\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"image-to-video\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"minimax/h3-max/reference-to-video\\\",\\n \\\"prompt\\\": \\\"Image 1 is the female protagonist. Image 2 is her small dog. Keep the woman and dog consistent with their respective reference images while they walk together through a sunlit garden.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"minimax/h3-max/reference-to-video\\\",\\n \\\"prompt\\\": \\\"Image 1 is the female protagonist. Image 2 is her small dog. Keep the woman and dog consistent with their respective reference images while they walk together through a sunlit garden.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"minimax/h3-max/reference-to-video\\\",\\n \\\"prompt\\\": \\\"Image 1 is the female protagonist. Image 2 is her small dog. Keep the woman and dog consistent with their respective reference images while they walk together through a sunlit garden.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"minimax/h3-max/reference-to-video\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "H3 Max Reference to Video" + modelId: "minimax/h3-max/reference-to-video" + vendor: "MiniMax" + vendorSlug: "minimax" + modelSlug: "h3-max/reference-to-video" + protocol: "Video Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-31T20:32:22.303Z" + capabilities: ["image-to-video"] + category: "Video Generation" +--- + + diff --git a/model-api-reference/video-generation/minimax/h3-max/text-to-video.md b/model-api-reference/video-generation/minimax/h3-max/text-to-video.md new file mode 100644 index 00000000..be720b84 --- /dev/null +++ b/model-api-reference/video-generation/minimax/h3-max/text-to-video.md @@ -0,0 +1,21 @@ +--- +title: "MiniMax H3 Max Text to Video API Reference" +description: "MiniMax H3 Max Text to Video API reference for SandBase. Use model minimax/h3-max/text-to-video with /v1/run; see request and response examples." +aside: false +outline: false +apiReferenceKey: "video/minimax/h3-max/text-to-video" +apiReferenceJson: "{\"title\":\"MiniMax H3 Max Text to Video\",\"operation\":\"Video Generation\",\"method\":\"POST\",\"path\":\"/v1/run\",\"description\":\"H3 Max by MiniMax - generate cinematic videos from text descriptions with AI. Create high-quality video content with natural motion, camera control, and optional audio generation.\",\"groups\":[{\"title\":\"Request body\",\"description\":\"Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.\",\"fields\":[{\"name\":\"model\",\"type\":\"string\",\"required\":true,\"description\":\"Model identifier. Set to minimax/h3-max/text-to-video.\",\"default\":\"minimax/h3-max/text-to-video\"},{\"name\":\"prompt\",\"type\":\"string\",\"required\":true,\"description\":\"Text prompt for video generation\"},{\"name\":\"aspect_ratio\",\"type\":\"string\",\"required\":false,\"description\":\"The aspect ratio of the generated image.\",\"constraints\":\"Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16\"},{\"name\":\"resolution\",\"type\":\"string\",\"required\":false,\"description\":\"The native generation resolution of the video.\",\"default\":\"768P\",\"constraints\":\"Allowed values: 480P, 768P\"},{\"name\":\"duration\",\"type\":\"integer\",\"required\":false,\"description\":\"The duration of the video in seconds.\",\"default\":\"5\",\"constraints\":\"Range: 5 to 15\"},{\"name\":\"seed\",\"type\":\"integer\",\"required\":false,\"description\":\"Random seed. A random seed is selected when omitted.\"},{\"name\":\"prompt_expansion_mode\",\"type\":\"string\",\"required\":false,\"description\":\"How much effort to spend rewriting the prompt before generation. 'balanced' returns in about a second. 'quality' spends up to ~30s on a richer prompt.\",\"default\":\"balanced\"}]},{\"title\":\"Response Schema\",\"description\":\"The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.\",\"fields\":[{\"name\":\"id\",\"type\":\"string\",\"required\":true,\"description\":\"Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.\"},{\"name\":\"status\",\"type\":\"string\",\"required\":true,\"description\":\"Current public run status.\",\"constraints\":\"Allowed values: pending, running, completed, failed, timeout\"},{\"name\":\"model\",\"type\":\"string\",\"required\":false,\"description\":\"Public SandBase model name used for this run.\"},{\"name\":\"outputs\",\"type\":\"array\",\"required\":false,\"description\":\"Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.\"},{\"name\":\"error\",\"type\":\"object\",\"required\":false,\"description\":\"Present only for failed or timeout runs. Contains a public error type and sanitized message.\"},{\"name\":\"error.type\",\"type\":\"string\",\"required\":false,\"description\":\"Stable public error category.\"},{\"name\":\"error.message\",\"type\":\"string\",\"required\":false,\"description\":\"Sanitized error message safe to show to clients.\"},{\"name\":\"usage\",\"type\":\"object\",\"required\":false,\"description\":\"Usage details when available.\"}]},{\"title\":\"Model capabilities\",\"fields\":[{\"name\":\"capability_tags\",\"type\":\"array\",\"required\":true,\"description\":\"Capabilities declared by the model registry.\",\"default\":\"text-to-video\"},{\"name\":\"execution_mode\",\"type\":\"string\",\"required\":true,\"description\":\"Execution mode declared by the model registry.\",\"default\":\"async\"}]}],\"examples\":[{\"label\":\"cURL\",\"language\":\"bash\",\"code\":\"# 1. Submit a generation request\\ncurl -X POST https://api.sandbase.ai/v1/run \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\" \\\\\\n -H \\\"Content-Type: application/json\\\" \\\\\\n -d '{\\n \\\"model\\\": \\\"minimax/h3-max/text-to-video\\\",\\n \\\"prompt\\\": \\\"A white kitten chases a butterfly across a sunlit garden. Gentle camera tracking, natural movement, soft afternoon light filtering through the leaves.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n}'\\n\\n# 2. If the response is still running, poll the returned id\\ncurl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \\\\\\n -H \\\"Authorization: Bearer $SANDBASE_API_KEY\\\"\"},{\"label\":\"Python\",\"language\":\"python\",\"code\":\"import os\\nimport time\\nimport requests\\n\\napi_url = \\\"https://api.sandbase.ai\\\"\\nheaders = {\\n \\\"Authorization\\\": f\\\"Bearer {os.environ['SANDBASE_API_KEY']}\\\",\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n}\\npayload = {\\n \\\"model\\\": \\\"minimax/h3-max/text-to-video\\\",\\n \\\"prompt\\\": \\\"A white kitten chases a butterfly across a sunlit garden. Gentle camera tracking, natural movement, soft afternoon light filtering through the leaves.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n}\\n\\nresponse = requests.post(f\\\"{api_url}/v1/run\\\", headers=headers, json=payload)\\nresponse.raise_for_status()\\nresult = response.json()\\n\\nwhile result[\\\"status\\\"] in (\\\"pending\\\", \\\"running\\\"):\\n time.sleep(2)\\n result = requests.get(f\\\"{api_url}/v1/run/\\\" + result[\\\"id\\\"], headers=headers).json()\\n\\nprint(result)\"},{\"label\":\"TypeScript\",\"language\":\"typescript\",\"code\":\"const apiUrl = \\\"https://api.sandbase.ai\\\";\\nconst headers = {\\n Authorization: `Bearer ${process.env.SANDBASE_API_KEY}`,\\n \\\"Content-Type\\\": \\\"application/json\\\",\\n};\\n\\nconst payload = {\\n \\\"model\\\": \\\"minimax/h3-max/text-to-video\\\",\\n \\\"prompt\\\": \\\"A white kitten chases a butterfly across a sunlit garden. Gentle camera tracking, natural movement, soft afternoon light filtering through the leaves.\\\",\\n \\\"aspect_ratio\\\": \\\"21:9\\\",\\n \\\"duration\\\": 5\\n};\\n\\nconst submit = await fetch(apiUrl + \\\"/v1/run\\\", {\\n method: \\\"POST\\\",\\n headers,\\n body: JSON.stringify(payload),\\n});\\nif (!submit.ok) throw new Error(await submit.text());\\nlet result = await submit.json();\\n\\nwhile ([\\\"pending\\\", \\\"running\\\"].includes(result.status)) {\\n await new Promise((resolve) => setTimeout(resolve, 2000));\\n const poll = await fetch(apiUrl + \\\"/v1/run/\\\" + result.id, { headers });\\n if (!poll.ok) throw new Error(await poll.text());\\n result = await poll.json();\\n}\\n\\nconsole.log(result);\"}],\"response\":{\"status\":\"202 Accepted\",\"code\":\"{\\n \\\"id\\\": \\\"f3d2e8a1-7c4b-4a12-9d2e-123456789abc\\\",\\n \\\"model\\\": \\\"minimax/h3-max/text-to-video\\\",\\n \\\"status\\\": \\\"running\\\"\\n}\"}}" +seo: + modelName: "MiniMax H3 Max Text to Video" + modelId: "minimax/h3-max/text-to-video" + vendor: "MiniMax" + vendorSlug: "minimax" + modelSlug: "h3-max/text-to-video" + protocol: "Video Generation Reference" + endpoint: "/v1/run" + publishedAt: "2026-08-26T20:24:56.547Z" + capabilities: ["text-to-video"] + category: "Video Generation" +--- + + diff --git a/scripts/generate-llm-model-api-reference.mjs b/scripts/generate-llm-model-api-reference.mjs index 08659bf2..352bde19 100644 --- a/scripts/generate-llm-model-api-reference.mjs +++ b/scripts/generate-llm-model-api-reference.mjs @@ -420,6 +420,7 @@ function endpointFor(model, category) { if (category.key === 'api') return `/v1/api/${model.name}` if (['image', 'video', 'audio'].includes(category.key)) return '/v1/run' if (isGeminiInteractionsModel(model)) return '/v1beta/interactions' + if (model.vendor_slug === 'openai') return '/v1/responses' return model.vendor_slug === 'anthropic' ? '/v1/messages' : '/v1/chat/completions' } @@ -493,6 +494,8 @@ function loadModels(root, filter, category) { __category: category.key, } }) + // Gemini Interactions models are documented only under official-native-api. + .filter((model) => !(category.key === 'llm' && isGeminiInteractionsModel(model))) .filter((model) => isEnabled(model) && isPubliclyDocumented(model) && filter(model)) } @@ -1757,7 +1760,7 @@ const sidebarItems = [ ...category.sortedGroups.map((group) => [ ` // Duplicate model names are qualified with provider and operation path for navigation clarity.`, ' {', - ` text: ${tsString(group.vendor)},`, + ` text: ${tsString(vendorLabel(group.vendor))},`, ' collapsed: true,', ' items: [', ...group.models.map((model) => ` ${sidebarItem(model, category, duplicateTitlesFor(category.models))},`),