cURL
curl --fail-with-body --request POST \
--url "$XPILOT_API_BASE_URL/v1/voices/speech" \
--header "Authorization: Bearer $XPILOT_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: lesson-request-001' \
--data '{"text":"Welcome to our lesson.","voice_id":"<voice_id>","voice_version":1}'const response = await fetch(process.env.XPILOT_API_BASE_URL + "/v1/voices/speech", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "lesson-request-001",
},
body: JSON.stringify({
"text": "Welcome to our lesson.",
"voice_id": "<voice_id>",
"voice_version": 1
}),
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result));
console.log(result);import os, json, requests
response = requests.request(
"POST",
os.environ["XPILOT_API_BASE_URL"] + "/v1/voices/speech",
headers={
"Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
"Content-Type": "application/json",
"Idempotency-Key": "lesson-request-001",
},
json=json.loads("{\"text\":\"Welcome to our lesson.\",\"voice_id\":\"<voice_id>\",\"voice_version\":1}"),
timeout=70,
)
print(response.status_code, response.text)
response.raise_for_status(){
"data": {
"audio_url": "data:audio/mpeg;base64,<mp3_bytes>",
"format": "mp3",
"voice_id": "<voice_id>",
"voice_version": 1,
"billing_basis": "platform_tts",
"cost_credits": 0
}
}{
"error": {
"code": "invalid_parameter",
"message": "Check parameter types, required fields and idempotency key."
},
"request_id": "<request_id>"
}{
"error": {
"code": "invalid_token",
"message": "Use an active scoped API Key. MCP OAuth tokens cannot call REST."
},
"request_id": "<request_id>"
}{
"error": {
"code": "insufficient_scope",
"message": "Check the credential scope and resource ownership."
},
"request_id": "<request_id>"
}{
"error": {
"code": "idempotency_conflict",
"message": "The same idempotency key must use the exact same input. A conversation may already be busy."
},
"request_id": "<request_id>"
}{
"error": {
"code": "rate_limited",
"message": "Credential/workspace rate or concurrency limit reached. Respect Retry-After before retrying.",
"retry_after": 60
},
"request_id": "<request_id>"
}Voices & audio
generate audio
Synthesize up to 1,000 characters with a catalog voice or one of your ready clones, in Voice I or Voice II. voice_version must match the voice. Returns MP3 audio_url (which may be a data URL). Uses platform TTS pricing; reuse the same Idempotency-Key for retries.
POST
/
v1
/
voices
/
speech
cURL
curl --fail-with-body --request POST \
--url "$XPILOT_API_BASE_URL/v1/voices/speech" \
--header "Authorization: Bearer $XPILOT_API_KEY" \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: lesson-request-001' \
--data '{"text":"Welcome to our lesson.","voice_id":"<voice_id>","voice_version":1}'const response = await fetch(process.env.XPILOT_API_BASE_URL + "/v1/voices/speech", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.XPILOT_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "lesson-request-001",
},
body: JSON.stringify({
"text": "Welcome to our lesson.",
"voice_id": "<voice_id>",
"voice_version": 1
}),
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result));
console.log(result);import os, json, requests
response = requests.request(
"POST",
os.environ["XPILOT_API_BASE_URL"] + "/v1/voices/speech",
headers={
"Authorization": "Bearer " + os.environ["XPILOT_API_KEY"],
"Content-Type": "application/json",
"Idempotency-Key": "lesson-request-001",
},
json=json.loads("{\"text\":\"Welcome to our lesson.\",\"voice_id\":\"<voice_id>\",\"voice_version\":1}"),
timeout=70,
)
print(response.status_code, response.text)
response.raise_for_status(){
"data": {
"audio_url": "data:audio/mpeg;base64,<mp3_bytes>",
"format": "mp3",
"voice_id": "<voice_id>",
"voice_version": 1,
"billing_basis": "platform_tts",
"cost_credits": 0
}
}{
"error": {
"code": "invalid_parameter",
"message": "Check parameter types, required fields and idempotency key."
},
"request_id": "<request_id>"
}{
"error": {
"code": "invalid_token",
"message": "Use an active scoped API Key. MCP OAuth tokens cannot call REST."
},
"request_id": "<request_id>"
}{
"error": {
"code": "insufficient_scope",
"message": "Check the credential scope and resource ownership."
},
"request_id": "<request_id>"
}{
"error": {
"code": "idempotency_conflict",
"message": "The same idempotency key must use the exact same input. A conversation may already be busy."
},
"request_id": "<request_id>"
}{
"error": {
"code": "rate_limited",
"message": "Credential/workspace rate or concurrency limit reached. Respect Retry-After before retrying.",
"retry_after": 60
},
"request_id": "<request_id>"
}Documentation by X-Pilot
Required scope:audio:write. A stable Idempotency-Key is required for exact retries.
Manage API keys · Authentication and recovery

Authorizations
Scoped X-Pilot API key
Headers
Stable key for exact retries only. Use a different key for a different operation or input.
Required string length:
8 - 128Body
application/json
Spoken text.
Maximum string length:
1000Example:
"Welcome to our lesson."
Catalog voice ID or owned ready clone ID.
Voice version of voice_id: Voice I (1, default) or Voice II (2). Never substitute one version for the other.
Available options:
1, 2 Speech locale. Voice II catalog voices accept their native or secondary locales; Voice II clones accept the locales they support.
Playback speed.
Required range:
0.5 <= x <= 2Response
Success
