Voice Design
POST /api/v1/voice-design/submit
textContent is required and toneDescription is required.
Required inputs
textContentstring- Text to synthesize (max 500 chars).
toneDescriptionstring- Description of the desired voice / tone.
Edit the sample inputs for your own task before submitting.
# 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": ... }Parameters and input rules2 fields
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
textContent | string | Yes | Not specified | Text to synthesize (max 500 chars). Maximum length: 500 |
toneDescription | string | Yes | Not specified | Description of the desired voice / tone. No additional field constraint listed. |
Retrieve the result
Save taskId from the accepted submission and send it to this endpoint:
POST /api/v1/voice-design/query
Use the same Bearer API key. On completion, read the audioUrl result field.
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://..." } }