Voice Design API documentation
Design a voice from a tone description and synthesize given text.
Endpoints
| Contract item | Value |
|---|---|
| Capability | voice-design |
| Submit | POST https://vidmage.ai/api/v1/voice-design/submit |
| Query | POST https://vidmage.ai/api/v1/voice-design/query |
| Task identifier | taskId |
| Result field | audioUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: AI Voice Design API for Described Speech
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
textContent | string | Yes | Not specified | Text to synthesize (max 500 chars). Maximum characters: 500 |
toneDescription | string | Yes | Not specified | Description of the desired voice / tone. |
Example request
{
"textContent": "Welcome to VidMage.",
"toneDescription": "Warm, clear, and conversational."
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/voice-design/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"textContent":"Welcome to VidMage.","toneDescription":"Warm, clear, and conversational."}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the synthesized audio. Read audioUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/voice-design/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "audioUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| Script length | 0.1 credits / character | 5 credits |
Character count × rate is rounded up to whole credits; the minimum charge applies.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.