docs.emix.ai
language
language
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡¨πŸ‡³ Chinese
language
language
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡¨πŸ‡³ Chinese
Market
File Upload API
Market
File Upload API
  1. Market
  • Webhook Security Verification
  • Getting Started with Emix API (Important)
  • Market
  • Image Models
    • Topaz
      • Topaz - Image Upscale
    • Seedream
      • Seedream3.0 - Text to Image
      • Seedream4.0 - Text to Image
      • Seedream4.0 - Edit
      • Seedream4.5 - Text to Image
      • Seedream4.5 - Edit
      • Seedream5.0 Lite - Text to Image
      • Seedream5.0 Lite - Image to Image
      • Seedream5.0 Pro - Text to Image
      • Seedream5.0 Pro - Image to Image
      • Seedream5.0 Pro - Layer Decomposition
      • Seedream5.0 Flash - Image to Imag
      • Seedream5.0 Flash - Text to Image
      • Seedream5.0 Flash - Layer Decomposition
      • Seedream5.5 - Text to Image
      • Seedream5.5 - Image to Image
      • Seedream5.5 - Layer Decomposition
    • Z-image
      • Z-Image
    • Google
      • Google - imagen4-fast
      • Google - imagen4-ultra
      • Google - imagen4
      • Google - Nano Banana
      • Google - Nano Banana Pro
      • Google - Nano Banana 2
      • Google - Nano Banana 2 Lite
      • Google - Nano Banana 2.1
    • Flux-2
      • Flux-2 - Pro Image to Image
      • Flux-2 - Pro Text to Image
      • Flux-2 - Image to Image
      • Flux-2 - Text to Image
    • Grok Imagine
      • Grok Imagine - Text to Image
      • Grok Imagine - image to image
      • Grok Imagine Image 2.0 Text To Image
      • Grok Imagine Image 2.0 Segment Map
      • Grok Imagine Image 2.0 Image Edit
    • GPT Image
      • GPT Image 2.5 Sunburst Text to Image
      • GPT Image 2.5 Sunburst Image to Image
      • GPT Image 2.5 Flare Text to Image
      • GPT Image 2.5 Flare Image to Image
      • GPT Image 2.6 Flare Text to Image
      • GPT Image 2.6 Flare Image to Image
      • GPT Image 2.6 Sunburst Text to Image
      • GPT Image 2.6 Sunburst Image to Image
      • GPT Image 2.6 Economy Text to Image
      • GPT Image 2.6 Economy Image to Image
      • GPT Image-1.5 - Text to Image
      • GPT Image-1.5 - Image to Image
      • GPT Image-2 - Text to Image
      • GPT Image 2 - Image To Image
    • Recraft
      • Recraft - Remove Background
      • Recraft - Crisp Upscale
    • Ideogram
      • Ideogram - V3 Reframe
      • Ideogram - Character Edit
      • Ideogram - Character Remix
      • Ideogram - Character
      • Ideogram V3 Text to Image
      • Ideogram V3 Edit
      • Ideogram V3 Remix
    • 4o Image API
      • 4o Image API Quickstart
      • 4o Image Generation Callbacks
      • Generate 4o Image
      • Get 4o Image Details
      • Get Direct Download URL
    • Flux Kontext API
      • Flux Kontext API Quickstart
      • Image Generation or Editing Callbacks
      • Generate or Edit Image
      • Get Image Details
    • Qwen
      • Qwen - Text to Image
      • Qwen - Image to Image
      • Qwen - Image Edit
      • Qwen2 - Image Edit
      • Qwen2 - Text To Image
      • Qwen3 Pro Text to Image
      • Qwen3 Text to Image
      • Qwen3 Pro Image to Image
      • Qwen3 Image to Image
      • Qwen 2.1 - Text to Image
      • Qwen 2.1 - Image to Image
    • Wan
      • Wan 2.7 Image
      • Wan 2.7 Image Pro
    • Flux-3
      • FLUX 3 Klein Text to Image
      • FLUX 3 Klein Edit Image
    • Emix
      • Emix - Image Upscale
    • Kling
      • Kling 4.0 Image
      • Kling 4.0 Long Image
    • MiniMax H3-Image
      • MiniMax H3 Text to Image
      • MiniMax H3 Image Edit
  • Video Models
    • OmniHuman
      • OmniHuman 2.0
      • Omnihuman 1.5
      • Omnihuman 1.5 Human Identification
      • OmniHuman 1.5 Subject Detection
    • Hailuo
      • Hailuo 2.3 Pro Image to Video
      • Hailuo 2.3 Standard Image to Video
      • Hailuo Pro Text to Video
      • Hailuo Pro Image to Video
      • Hailuo Standard Text to Video
      • Hailuo Standard Image to Video
    • Topaz
      • Topaz - Video Upscale
    • Runway API
      • Runway Image To Video
      • Runway Text To Video
      • Runway Video Extension
    • Wan
      • Wan - 2.2 A14B Image to Video Turbo
      • Wan - 2.2 A14B Speech to Video Turbo
      • Wan - 2.2 A14B Text to Video Turbo
      • Wan - Animate Move
      • Wan - Animate Replace
      • Wan 2.6 - Image to Video
      • Wan 2.6 - Text to Video
      • Wan 2.6 - Video to Video
      • Wan 2.6 Flash - Image to Video
      • Wan 2.6 Flash - Video to Video
      • Wan 2.5 - Image to Video
      • Wan 2.5 - Text to Video
      • Wan 2.7 - Text to Video
      • Wan 2.7 - Image to Video
      • Wan 2.7 - Video Edit
      • Wan 2.7 - Reference to Video
      • Wan 3.0 - Video
      • Wan 3.0 - Video Prime
    • HappyHorse
      • HappyHorse - text-to-video
      • HappyHorse - image-to-video
      • HappyHorse - reference-to-video
      • HappyHorse - video-edit
      • HappyHorse-1-1 image-to-video
      • HappyHorse-1-1 text-to-video
      • HappyHorse-1-1 reference-to-video
    • Grok Imagine
      • Grok Imagine Text to Video
      • Grok Imagine Image to Video
      • Grok Imagine - Video Upscale
      • Grok Imagine - Video Extend
      • Grok Imagine Video 1.5 Preview
    • Kling
      • Kling 2.6 Text to Video
      • Kling 2.6 Image to Video
      • Kling - V2.5 Turbo Image to Video Pro
      • Kling - V2.5 Turbo Text to Video Pro
      • Kling AI Avatar Standard
      • Kling AI Avatar Pro
      • Kling V2.1 Master Image to Video
      • Kling V2.1 Master Text to Video
      • Kling V2.1 Pro
      • Kling V2.1 Standard
      • Kling 2.6 motion-control
      • Kling-3.0 motion-control
      • Kling 3.0
      • Kling - V3 Turbo Text to Video
      • Kling - V3 Turbo Image to Video
      • Kling 3.0 Omni Reference To Video
      • Kling 3.0 Omni Transformation
      • Kling 3.0 Omni Image To Video
      • Kling 3.0 Omni Text to Video
      • Kling 4.0 Reference To Video
      • Kling 4.0 Keyframe To Video
      • Kling 4.0 Flash Keyframe To Video
      • Kling 4.0 Flash Reference To Video
    • Bytedance
      • Bytedance Seedance 2.5 Flash
      • Bytedance Seedance 2.0
      • Bytedance Seedance 2.0 Fast
      • Bytedance Seedance 2.0 Mini
      • Bytedance Seedance 1.5 Pro
      • Bytedance V1 Pro Fast Image to Video
      • Bytedance V1 Pro Image to Video
      • Bytedance - V1 Pro Text to Video
      • Bytedance - V1 Lite Image to Video
      • Bytedance - V1 Lite Text to Video
      • Bytedance Seedance 2.5
      • Bytedance Seedance 2.5 Draft
    • Veo3.1 API
      • Get 4K Video Callbacks
      • Veo3.1 API Quickstart
      • Veo3.1 Video Generation Callbacks
      • Generate Veo3.1 Video
      • Get Veo3.1 Video Details
      • Get 1080P Video
      • Get 4K Video
      • VEO 3.1 Extend Video
      • VEO 3.1 Text to video
      • VEO 3.1 Image to video
      • VEO 3.1 Reference to vidoe
    • Gemini Omni
      • Gemini Omni 1.1 Flash
      • Gemini Omni 1.2 Flash
      • Gemini Omni Flash 1.2 Extend
      • Gemini Omni Video
      • Gemini Omni Audio
      • Gemini Omni Character
    • Volcengine
      • Volcengine video to video lip sync
    • PixVerse
      • PixVerse V6 Max Image-to-Video
      • PixVerse V6 Max Text-to-Video
      • PixVerse V6 Text-to-Video
      • PixVerse V6 Image-to-Video
      • PixVerse V6 First & Last Frame Transition
      • PixVerse V6 Video Extension
      • PixVerse V6 Fusion / Reference-to-Video
    • MiniMax H3
      • MiniMax H3 Text-to-Video
      • MiniMax H3 Image-to-Video
      • MiniMax H3 Reference-to-Video
    • Vidu
      • Vidu Q4 Image To Video
      • Vidu Q4 Reference To Video
    • Emix
      • Emix - Video Upscale
    • LTX
      • LTX 2.5 Fast Text to Video
      • LTX 2.5 Fast Image to Video
      • LTX 2.5 Fast Audio to Video
      • LTX 2.5 Pro Text to Video
      • LTX 2.5 Pro Image to Video
  • Music Models
    • ElevenLabs
      • elevenlabs/audio-isolation
      • elevenlabs/sound-effect-v2
      • elevenlabs/speech-to-text
      • elevenlabs/text-to-dialogue-v3
      • elevenlabs/text-to-speech-multilingual-v2
      • elevenlabs/text-to-speech-turbo-2-5
    • Suno API
      • Music Generation
        • Music Generation Callbacks
        • Music Extension Callbacks
        • Add Instrumental Callbacks
        • Add Vocals Callbacks
        • Music Cover Generation Callbacks
        • Replace Music Section Callbacks
        • Audio Upload and Extension Callbacks
        • Audio Upload and Cover Callbacks
        • Generate Music
        • Extend Music
        • Upload And Cover Audio
        • Upload And Extend Audio
        • Add Instrumental to Music
        • Add Vocals to Music
        • Get Timestamped Lyrics
        • Boost Music Style
        • Generate Music Cover
        • Replace Music Section
        • Generate Persona
        • Generate Mashup Music
      • Lyrics Generation
        • Lyrics Generation Callbacks
        • Generate Lyrics
      • WAV Conversion
        • Convert to WAV Format
      • Vocal Removal
        • Audio Separation Callbacks
        • Vocalβ€―&β€―Instrument Stem Separation
        • Generate MIDI from Audio
      • Music Video Generation
        • Music Video Generation Callbacks
        • Create Music Video
      • Sounds Generation
        • Generate sounds
      • Speech Generation
        • Generate speech
      • voice
        • Suno Voice Generation Callback
        • Suno Voice Validation Phrase Callback
        • Suno Voice Generate Verification Phrase API
        • Suno Voice Create Custom Voice API
        • Suno Voice Regenerate Verification Phrase
        • Suno Voice Check Availability API
    • Gemini
      • Gemini 3.8 Flash Text to speech
      • Gemini 3.8 Flash Lite Text to speech
      • Gemini 3.1 Flash Text to speech
      • Gemini 2.5 Pro Text to Speech
    • Nemotron 3.5 Transcribe
  • Chat Models
    • Codex
      • GPT Codex
    • Grok
      • Grok 4.5
      • Grok 4.7
      • Grok 4.3
      • Grok 4.6
    • GPT
      • Gpt 6 Astra
      • GPT 6.1 Terra
      • GPT 6 Luna
      • GPT 6 Sol
      • GPT 6.1 Sol
      • GPT 5.2
      • GPT 5.4 (response)
      • GPT 5.6 Luna
      • GPT 5.6 Terra
      • GPT 5.6 Sol
      • GPT 5.5 (response)
      • GPT 6.2 Sol
      • GPT 6.2 Astra
    • Claude
      • Claude Code + emix.ai Integration Guide
      • Claude Sonnet 5
      • Claude Opus 5.5
      • Claude Sonnet 5.5
      • Claude Haiku 5.5
      • Claude Sonnet 4.5
      • Claude Opus 4.7
      • Claude Opus 4.8
      • Claude Opus 5
      • Claude Fable 5
      • Claude Haiku 4.5
      • Claude Opus 4.5
      • Claude Opus 4.6
      • Claude Sonnet 4.5
      • Claude Sonnet 4.6
    • Gemini
      • Gemini 3.6 Flash
      • Gemini 3.6 Flash (openai)
      • Gemini 3.7 Flash (openai)
      • Gemini 4 Hydrogen
      • Gemini 4 Hydrogen (openai)
      • Gemini 4 Argon
      • Gemini 4 Argon (openai)
      • Gemini 4 Carbon
      • Gemini 4 Carbon (openai)
      • Gemini 4 Neon
      • Gemini 4 Neon (openai)
      • Gemini 2.5 Pro (openai)
      • Gemini 3 Pro (openai)
      • Gemini 3.1 Pro (openai)
      • Gemini 2.5 Flash (openai)
      • Gemini 3 Flash (openai)
      • Gemini 3.5 Flash
      • Gemini 3.5 Flash (openai)
      • Gemini 3 Flash
      • Gemini 3.7 Flash
      • Gemini 3.8 Flash
      • Gemini 3.8 Flash (openai)
    • Kimi
      • Kimi K3.1 Pro
      • Kimi K3
    • Deepseek
      • DeepSeek V4.1 Flash
  • Get Task Details
    GET
  1. Market

Webhook Security Verification

To ensure the security of callback requests, it is strongly recommended to enable Webhook HMAC signature verification in production environments to prevent forged or tampered requests.

Algorithm Overview#

Emix uses the HMAC-SHA256 algorithm to sign webhook callbacks, so you can confirm that a callback really comes from Emix and that its body was not changed in transit.
Signature Generation Process:
1.
Take the raw request body: the exact bytes of the JSON body Emix sends (UTF-8), before any parsing.
2.
Calculate HMAC-SHA256 signature with your Webhook HMAC Key as the secret:
signature = HMAC-SHA256(rawRequestBody, webhookHmacKey)
3.
Base64 encode the signature:
finalSignature = Base64.encode(signature)
Compute the signature over the raw body exactly as received. Do not parse the JSON and serialize it again before signing: changes in whitespace or key order will make the signature fail.

Obtain Webhook HMAC Key#

You can generate and view your webhookHmacKey on the Emix Settings Page (Settings β†’ Webhook HMAC Key). Generating a new key replaces the old one; callbacks sent afterwards are signed with the new key.
The webhookHmacKey is used to verify that callback requests originate from Emix's official servers. Keep this key secure and never expose it or commit it to code repositories.

Webhook Header Description#

Once you have generated a webhookHmacKey on the settings page, every callback request includes the following HTTP headers. If no key has been generated, callbacks are sent without signature headers.

X-Emix-Signature#

Type: String
Required: Yes (when a Webhook HMAC Key exists)
Description: Base64-encoded HMAC-SHA256 signature of the raw request body, using your webhookHmacKey as the secret. New integrations should verify this header.

X-Kie-Signature#

Type: String
Required: Yes (when a Webhook HMAC Key exists)
Description: Legacy header with exactly the same value as X-Emix-Signature. It is kept for backward compatibility, so existing integrations that verify it keep working.

Signature generation rule:#

base64(HMAC-SHA256(rawRequestBody, webhookHmacKey))
Where:
rawRequestBody is the raw callback body (UTF-8 bytes) as received by your server
webhookHmacKey is the key you generated in the console

Webhook Verification Process#

Follow these steps to verify the legitimacy of webhook requests:
1
Read the Raw Body and Header
Read the raw request body bytes before any JSON parsing, and extract the X-Emix-Signature header.
2
Generate Signature
Using your locally stored webhookHmacKey, compute the HMAC-SHA256 of the raw body and Base64 encode it.
3
Compare Signatures
Compare the computed signature with X-Emix-Signature using a constant-time comparison algorithm to prevent timing attacks.

Complete Example Code#

Here are complete examples of implementing webhook signature verification in popular programming languages:
Node.js
Python
PHP
Java

Example Webhook Request#

Here's what a signed webhook request looks like:

Notes#

Respond with a 2xx status within 10 seconds. Emix waits at most 10 seconds for your endpoint and does not retry a failed callback, so use the task detail API to recover results you missed.
If you already verify X-Kie-Signature, it keeps working with the same value. Switching to X-Emix-Signature needs no other change.
If your key leaks, generate a new one on the settings page and update your server.
Next
Getting Started with Emix API (Important)
Built with