> ## Documentation Index
> Fetch the complete documentation index at: https://developers.x-pilot.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
export const XpilotArticleMetadata = () => ;
Voices & audio / generate audio Documentation by X-Pilot
Required scope: `audio:write`. A stable `Idempotency-Key` is required for exact retries.
[Manage API keys](https://app.x-pilot.ai/developers/console) ยท [Authentication and recovery](/api-reference)
export const XpilotDocFigure = () => REST requests use a scoped API key. Keys, credits and usage are managed in the App console.
format: mp3
voice_id:
voice_version: 1
billing_basis: platform_tts
cost_credits: 0
'400':
description: Check parameter types, required fields and idempotency key.
content:
application/json:
example:
error:
code: invalid_parameter
message: Check parameter types, required fields and idempotency key.
request_id:
'401':
description: Use an active scoped API Key. MCP OAuth tokens cannot call REST.
content:
application/json:
example:
error:
code: invalid_token
message: >-
Use an active scoped API Key. MCP OAuth tokens cannot call
REST.
request_id:
'403':
description: Check the credential scope and resource ownership.
content:
application/json:
example:
error:
code: insufficient_scope
message: Check the credential scope and resource ownership.
request_id:
'409':
description: >-
The same idempotency key must use the exact same input. A
conversation may already be busy.
content:
application/json:
example:
error:
code: idempotency_conflict
message: >-
The same idempotency key must use the exact same input. A
conversation may already be busy.
request_id:
'429':
description: >-
Credential/workspace rate or concurrency limit reached. Respect
Retry-After before retrying.
content:
application/json:
example:
error:
code: rate_limited
message: >-
Credential/workspace rate or concurrency limit reached.
Respect Retry-After before retrying.
retry_after: 60
request_id:
x-codeSamples:
- lang: curl
label: cURL
source: |-
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_version":1}'
- lang: javascript
label: JavaScript
source: >-
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_version": 1
}),
});
const result = await response.json();
if (!response.ok) throw new Error(JSON.stringify(result));
console.log(result);
- lang: python
label: Python
source: |-
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_version\":1}"),
timeout=70,
)
print(response.status_code, response.text)
response.raise_for_status()
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Scoped X-Pilot API key
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform. 