VibeVoice API: Pricing, Documentation
by Microsoft
VibeVoice API, developers can convert text into realistic speech with multiple voice options and speaking styles. The API includes real-time capabilities for interactive applications, making it suitable for virtual assistants, accessibility features, and any application requiring natural-sounding voice output.

Models Version
Get $5 Free Credit on First Payment
No strings attached — add funds and get $5 bonus instantly
VibeVoice v1 API Documentation
https://gateway.pixazo.ai/vibevoice/v1/vibevoice/generateRequest
Authentication
All requests require an API key passed via header.
| Header | Type | Required | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | string | Yes | Your API subscription key |
Text to Speech - Vibe Voice API
Request Code
POST https://gateway.pixazo.ai/vibevoice/v1/vibevoice/generateRequest
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
{
"script": "Speaker 0: Hello, this is a test of the VibeVoice API.",
"speakers": [
{
"preset": "Alice [EN]"
}
]
}
import requests
url = "https://gateway.pixazo.ai/vibevoice/v1/vibevoice/generateRequest"
headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
"script": "Speaker 0: Hello, this is a test of the VibeVoice API.",
"speakers": [
{
"preset": "Alice [EN]"
}
]
}
response = requests.post(url, json=data, headers=headers)
print(response.json())
const url = "https://gateway.pixazo.ai/vibevoice/v1/vibevoice/generateRequest";
const headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
};
const data = {
script: "Speaker 0: Hello, this is a test of the VibeVoice API.",
speakers: [
{
preset: "Alice [EN]"
}
]
};
fetch(url, {
method: "POST",
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));
curl -v -X POST "https://gateway.pixazo.ai/vibevoice/v1/vibevoice/generateRequest" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
"script": "Speaker 0: Hello, this is a test of the VibeVoice API.",
"speakers": [
{
"preset": "Alice [EN]"
}
]
}'
Output
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "QUEUED",
"polling_url": "https://gateway.pixazo.ai/v2/requests/status/vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Webhook (Optional)
Add the X-Webhook-URL header to your submit request to receive a POST callback when the job completes — no polling required.
Using curl? These are HTTP request headers — pass each with -H, e.g. -H "X-Webhook-URL: https://your-server.com/webhook/callback". Do not paste them as bare lines, and end every line of a multi-line command with \.
Webhook Headers
| Header | Required | Default | Description |
|---|---|---|---|
X-Webhook-URL | Yes (to enable) | — | HTTPS endpoint on your server that will receive the POST callback. Must respond 2xx within a few seconds (process async if needed). |
X-Webhook-Mode | No | terminal | terminal — fires once at the final status (COMPLETED/FAILED/ERROR). sync — fires on every poll cycle plus the terminal event, and caps the queue’s polling delay at 15s for tighter progress updates. |
Example: enable webhook
X-Webhook-URL: https://your-server.com/webhook/callback
X-Webhook-Mode: terminal
Callback Payload
Your endpoint receives a POST application/json with the same shape as the GET /v2/requests/status/{request_id} response. Example terminal callback (mode terminal):
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"model_id": "vibevoice",
"error": null,
"output": {
"media_url": [
"https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/output.wav"
],
"media_type": "audio/wav"
},
"created_at": "2026-05-22T13:17:32.110Z",
"updated_at": "2026-05-22 13:19:23",
"completed_at": "2026-05-22 13:19:23"
}
Failure callback shape
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "ERROR",
"model_id": "vibevoice",
"error": "Description of the error",
"output": null,
"created_at": "...",
"updated_at": "...",
"completed_at": "..."
}
Delivery semantics
- terminal mode (default) — exactly one
POSTwhen the request reaches a terminal status. No callback duringPROCESSING. - sync mode —
POSTon every status poll (with delay capped at ~15s) plus a finalPOSTat terminal status. Use when you want progress updates. - Idempotency — use
request_idas your idempotency key. Network retries can deliver the same callback more than once; your handler must tolerate duplicates. - Response — respond
200 OKwithin a few seconds. The queue does not block on slow handlers, but persistent failures may stop further deliveries. - HTTPS required — plain
http://URLs are rejected.
Request Parameters - Text to Speech
| Parameter | Required | Type | Default | Allowed values / range | Description |
|---|---|---|---|---|---|
| script | Yes | string | — | — | The script to convert to speech. Prefix each line with Speaker 0:, Speaker 1:, … for multi-speaker dialogues — the index maps to the matching entry in speakers. This is the main text content that will be converted to audio. |
| speakers | Yes | array<object> | — | — | List of speakers used by the script — one object per distinct speaker (up to 4). Each object supplies either a preset (built-in voice) or an audio_url (voice cloned from your own sample). |
| speakers[].preset | No | string | Alice [EN] | Alice [EN], Carter [EN], Frank [EN], Mary [EN] (Background Music), Maya [EN], Anchen [ZH] (Background Music), Bowen [ZH], Xinran [ZH] | Built-in voice preset for this speaker. Not used if audio_url is provided. Pass the value exactly as listed — including the (Background Music) suffix where shown. |
| speakers[].audio_url | No | string (URI) | — | — | URL to a voice sample audio file (MP3 or WAV) for voice cloning. If provided, preset is ignored and the voice is cloned from this sample. Length: ~20–30 seconds gives the best quality; 10–60 s works well; ~5 s is the practical minimum (lower quality) and clips longer than ~60 s add no benefit. Quality: use a clean, single-speaker clip with minimal background noise. Size: no hard limit — a typical 20–30 s MP3 is roughly 300–600 KB; keep it a short voice clip, not a long recording. |
| seed | No | integer | — | — | Random seed that controls the generation's randomness. Reuse the same seed with identical settings to reproduce the same result; leave it empty for a different output each time. |
| cfg_scale | No | float | 1.3 | 1–2 | Classifier-free guidance (CFG) scale — controls how closely the generated speech follows the script. Higher values increase adherence to the text; lower values allow more natural variation. |
Speakers & script mapping: each Speaker N label in script maps to speakers[N] (0-indexed): Speaker 0 → speakers[0], Speaker 1 → speakers[1], and so on. Provide one speakers[] entry per distinct speaker (up to 4); each entry uses either preset (a built-in voice) or audio_url (clone from your own audio). The number of distinct Speaker N labels in the script must not exceed the speakers you provide.
Content Item Types & Limits
| Type | Max | Format / Size | Description |
|---|---|---|---|
| audio | 4 | MP3, WAV | Reference voice for cloning — up to one per speaker (max 4), via speakers[].audio_url. Best with a clean, single-speaker clip of ~20–30 s (10–60 s ok; ~300–600 KB typical). |
Minimum Request
{
"script": "Speaker 0: Hello, this is a test of the VibeVoice API.",
"speakers": [
{
"preset": "Alice [EN]"
}
]
}
Full Request (all options)
{
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
],
"cfg_scale": 1.3,
"seed": 42
}
Voice Cloning (custom voice)
Give a speaker an audio_url to clone that voice from your own sample (MP3/WAV). When audio_url is provided, preset is ignored. For best results use a clean, single-speaker clip of about 20–30 seconds (10–60 s works).
{
"script": "Speaker 0: Hi everyone, this is my own voice, cloned with VibeVoice.",
"speakers": [
{
"audio_url": "https://your-storage.com/my-voice-sample.mp3"
}
]
}
Multi-Speaker Podcast (cloned voices)
Build a multi-voice podcast: provide one speakers[] entry per voice, each cloned from its own audio_url. Script lines prefixed Speaker 0: use speakers[0], Speaker 1: use speakers[1], and so on (up to 4 speakers). You can mix cloned voices and presets.
{
"script": "Speaker 0: Welcome back to the show! I am your first host.\nSpeaker 1: And I am the co-host, great to be here. Today we are talking about AI voice cloning.\nSpeaker 0: It is wild, you can clone a natural-sounding voice from just a short sample.\nSpeaker 1: Exactly. Let us dive in!",
"speakers": [
{
"audio_url": "https://your-storage.com/host-1.mp3"
},
{
"audio_url": "https://your-storage.com/host-2.mp3"
}
]
}
Response
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "QUEUED",
"polling_url": "https://gateway.pixazo.ai/v2/requests/status/vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Request Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Cache-Control | no-cache |
| Ocp-Apim-Subscription-Key | Your API subscription key |
Response Handling
Common status codes for Text to Speech.
| Code | Meaning |
|---|---|
| 202 | Accepted — Request queued |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
Error Responses
Queue system errors and model validation errors.
Queue System Errors
// 402 — Insufficient balance
{
"error": "Insufficient Balance",
"message": "Your wallet does not have enough balance."
}
// 400 — Model not found
{
"error": "Model not found",
"message": "Model 'vibevoice' not found or is disabled"
}
Error via Status/Webhook
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "ERROR",
"model_id": "vibevoice",
"error": "Description of the error",
"output": null
}
Retrieving Results
Poll the universal status endpoint to check progress and retrieve results.
Endpoint
GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY
cURL Example
curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
"https://gateway.pixazo.ai/v2/requests/status/vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Response (Completed)
{
"request_id": "vibevoice_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"model_id": "vibevoice",
"error": null,
"output": {
"media_url": [
"https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/vibevoice_019dxxxx-xxxx/output.ext"
],
"media_type": "application/octet-stream"
},
"created_at": "2026-03-31T10:00:00.000Z",
"updated_at": "2026-03-31T10:00:15.000Z",
"completed_at": "2026-03-31T10:00:15.000Z"
}
Response Fields
| Field | Type | Description |
|---|---|---|
| request_id | string | Unique request identifier |
| status | string | QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR |
| model_id | string | Model that processed the request |
| error | string|null | Error message if failed |
| output.media_url | array | URLs to generated media (R2 CDN) |
| output.media_type | string | MIME type of the output |
| created_at | string | When request was created |
| completed_at | string|null | When request completed |
| polling_url | string | Status URL (initial response only) |
Status Values
| Status | Description |
|---|---|
| QUEUED | Request accepted, waiting to be processed |
| PROCESSING | Being processed by the model |
| COMPLETED | Done — output contains the result |
| FAILED | Failed — check error field |
| ERROR | System error — not charged |
Status Flow
QUEUED → PROCESSING → COMPLETED
→ FAILED
→ ERROR
Typical Workflow
- Send a generate request to the API endpoint
- Save the
request_idfrom the response - Poll every 5-10 seconds:
GET /v2/requests/status/{request_id} - When
statusis"COMPLETED", download fromoutput.media_url
Tip: Use X-Webhook-URL header to get a callback instead of polling.
VibeVoice v1 API Pricing
VibeVoice v1 API Documentation
https://gateway.pixazo.ai/vibevoice-realtime-0-5b-135/v1/vibevoice-realtime-0-5b-request
Authentication
All requests require an API key passed via header.
Processing & billing: Generation is asynchronous and can take several minutes — poll the status endpoint until the request is COMPLETED (this is not a low-latency or streaming endpoint). Billed at $0.04 per minute of generated audio, rounded up to the nearest 15 seconds, with a $0.01 (15-second) minimum per request.
| Header | Type | Required | Description |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | string | Yes | Your API subscription key |
VibeVoice-Realtime-0.5B generate request - Vibe Voice-Realtime-0.5B
Request Code
POST https://gateway.pixazo.ai/vibevoice-realtime-0-5b-135/v1/vibevoice-realtime-0-5b-request
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
{
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
]
}
import requests
url = "https://gateway.pixazo.ai/vibevoice-realtime-0-5b-135/v1/vibevoice-realtime-0-5b-request"
headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
]
}
response = requests.post(url, json=data, headers=headers)
print(response.json())
const url = "https://gateway.pixazo.ai/vibevoice-realtime-0-5b-135/v1/vibevoice-realtime-0-5b-request";
const headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
};
const data = {
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
]
};
fetch(url, {
method: "POST",
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));
curl -X POST "https://gateway.pixazo.ai/vibevoice-realtime-0-5b-135/v1/vibevoice-realtime-0-5b-request" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
]
}'
Output
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "QUEUED",
"polling_url": "https://gateway.pixazo.ai/v2/requests/status/vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Webhook (Optional)
Add the X-Webhook-URL header to your submit request to receive a POST callback when the job completes — no polling required.
Using curl? These are HTTP request headers — pass each with -H, e.g. -H "X-Webhook-URL: https://your-server.com/webhook/callback". Do not paste them as bare lines, and end every line of a multi-line command with \.
Webhook Headers
| Header | Required | Default | Description |
|---|---|---|---|
X-Webhook-URL | Yes (to enable) | — | HTTPS endpoint on your server that will receive the POST callback. Must respond 2xx within a few seconds (process async if needed). |
X-Webhook-Mode | No | terminal | terminal — fires once at the final status (COMPLETED/FAILED/ERROR). sync — fires on every poll cycle plus the terminal event, and caps the queue’s polling delay at 15s for tighter progress updates. |
Example: enable webhook
X-Webhook-URL: https://your-server.com/webhook/callback
X-Webhook-Mode: terminal
Callback Payload
Your endpoint receives a POST application/json with the same shape as the GET /v2/requests/status/{request_id} response. Example terminal callback (mode terminal):
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"model_id": "vibevoice-realtime-0-5b-135",
"error": null,
"output": {
"media_url": [
"https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/output.wav"
],
"media_type": "audio/wav"
},
"created_at": "2026-05-22T13:17:32.110Z",
"updated_at": "2026-05-22 13:19:23",
"completed_at": "2026-05-22 13:19:23"
}
Failure callback shape
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "ERROR",
"model_id": "vibevoice-realtime-0-5b-135",
"error": "Description of the error",
"output": null,
"created_at": "...",
"updated_at": "...",
"completed_at": "..."
}
Delivery semantics
- terminal mode (default) — exactly one
POSTwhen the request reaches a terminal status. No callback duringPROCESSING. - sync mode —
POSTon every status poll (with delay capped at ~15s) plus a finalPOSTat terminal status. Use when you want progress updates. - Idempotency — use
request_idas your idempotency key. Network retries can deliver the same callback more than once; your handler must tolerate duplicates. - Response — respond
200 OKwithin a few seconds. The queue does not block on slow handlers, but persistent failures may stop further deliveries. - HTTPS required — plain
http://URLs are rejected.
Request Parameters - VibeVoice-Realtime-0.5B generate request
| Parameter | Required | Type | Default | Allowed values / range | Description |
|---|---|---|---|---|---|
| script | Yes | string | — | — | The dialogue script with speaker labels (e.g., "Speaker 0: Hello..."). Each line must begin with "Speaker X:" where X is a zero-based index matching the speakers array. |
| speakers | Yes | array<object> | — | — | List of speakers used by the script — one object per distinct speaker (up to 4). Each object supplies either a preset (built-in voice) or an audio_url (voice cloned from your own sample). |
| speakers[].preset | No | string | Alice [EN] | Alice [EN], Carter [EN], Frank [EN], Mary [EN] (Background Music), Maya [EN], Anchen [ZH] (Background Music), Bowen [ZH], Xinran [ZH] | Built-in voice preset for this speaker. Not used if audio_url is provided. Pass the value exactly as listed — including the (Background Music) suffix where shown. |
| speakers[].audio_url | No | string (URI) | — | — | URL to a voice sample audio file (MP3 or WAV) for voice cloning. If provided, preset is ignored and the voice is cloned from this sample. Length: ~20–30 s ideal (10–60 s works; ~5 s min, lower quality; >60 s no benefit). Quality: clean, single-speaker, minimal background noise. Size: no hard cap — a typical 20–30 s MP3 is ~300–600 KB. |
| seed | No | integer | — | — | Random seed that controls the generation's randomness. Reuse the same seed with identical settings to reproduce the same result; leave it empty for a different output each time. |
| cfg_scale | No | float | 1.3 | 1–2 | Classifier-free guidance (CFG) scale — controls how closely the generated speech follows the script. Higher values increase adherence to the text; lower values allow more natural variation. |
Voice Cloning & Multi-Speaker Podcast
Use audio_url on a speaker to clone a voice from your own sample. For a podcast, provide one speakers[] entry per voice, each with its own audio_url — Speaker 0: lines use speakers[0], Speaker 1: use speakers[1], and so on (up to 4). Best clone sample: a clean, single-speaker clip of ~20–30 s (10–60 s works; ~300–600 KB typical).
{
"script": "Speaker 0: Hi everyone, this is my own voice, cloned with VibeVoice.",
"speakers": [
{
"audio_url": "https://your-storage.com/my-voice-sample.mp3"
}
]
}
{
"script": "Speaker 0: Welcome back to the show! I am your first host.\nSpeaker 1: And I am the co-host, great to be here. Today we are talking about AI voice cloning.\nSpeaker 0: It is wild, you can clone a natural-sounding voice from just a short sample.\nSpeaker 1: Exactly. Let us dive in!",
"speakers": [
{
"audio_url": "https://your-storage.com/host-1.mp3"
},
{
"audio_url": "https://your-storage.com/host-2.mp3"
}
]
}
Minimum Request
{
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
]
}
Full Request (all options)
{
"script": "Speaker 0: VibeVoice is now available on Pixazo. Isn't that right, Carter?\nSpeaker 1: That's right Frank, and it supports up to four speakers at once. Try it now!",
"speakers": [
{
"preset": "Frank [EN]"
},
{
"preset": "Carter [EN]"
}
],
"cfg_scale": 1.3
}
Response
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "QUEUED",
"polling_url": "https://gateway.pixazo.ai/v2/requests/status/vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Request Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Cache-Control | no-cache |
| Ocp-Apim-Subscription-Key | Your API subscription key |
Response Handling
Common status codes for VibeVoice-Realtime-0.5B generate request.
| Code | Meaning |
|---|---|
| 202 | Accepted — Request queued |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal Server Error |
Error Responses
Queue system errors and model validation errors.
Queue System Errors
// 402 — Insufficient balance
{
"error": "Insufficient Balance",
"message": "Your wallet does not have enough balance."
}
// 400 — Model not found
{
"error": "Model not found",
"message": "Model 'vibevoice-realtime-0-5b-135' not found or is disabled"
}
Error via Status/Webhook
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "ERROR",
"model_id": "vibevoice-realtime-0-5b-135",
"error": "Description of the error",
"output": null
}
Retrieving Results
Poll the universal status endpoint to check progress and retrieve results.
Endpoint
GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY
cURL Example
curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
"https://gateway.pixazo.ai/v2/requests/status/vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Response (Completed)
{
"request_id": "vibevoice-realtime-0-5b-135_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "COMPLETED",
"model_id": "vibevoice-realtime-0-5b-135",
"error": null,
"output": {
"media_url": [
"https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/vibevoice-realtime-0-5b-135_019dxxxx-xxxx/output.ext"
],
"media_type": "application/octet-stream"
},
"created_at": "2026-03-31T10:00:00.000Z",
"updated_at": "2026-03-31T10:00:15.000Z",
"completed_at": "2026-03-31T10:00:15.000Z"
}
Response Fields
| Field | Type | Description |
|---|---|---|
| request_id | string | Unique request identifier |
| status | string | QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR |
| model_id | string | Model that processed the request |
| error | string|null | Error message if failed |
| output.media_url | array | URLs to generated media (R2 CDN) |
| output.media_type | string | MIME type of the output |
| created_at | string | When request was created |
| completed_at | string|null | When request completed |
| polling_url | string | Status URL (initial response only) |
Status Values
| Status | Description |
|---|---|
| QUEUED | Request accepted, waiting to be processed |
| PROCESSING | Being processed by the model |
| COMPLETED | Done — output contains the result |
| FAILED | Failed — check error field |
| ERROR | System error — not charged |
Status Flow
QUEUED → PROCESSING → COMPLETED
→ FAILED
→ ERROR
Typical Workflow
- Send a generate request to the API endpoint
- Save the
request_idfrom the response - Poll every 5-10 seconds:
GET /v2/requests/status/{request_id} - When
statusis"COMPLETED", download fromoutput.media_url
Tip: Use X-Webhook-URL header to get a callback instead of polling.