Skip to main content
POST
cURL

Documentation by X-Pilot

Required scope: audio:write. A stable Idempotency-Key is required for exact retries. Manage API keys · Authentication and recovery
An application sends a scoped API key to the X-Pilot REST API and receives an HTTP status and JSON response.
REST requests use a scoped API key. Keys, credits and usage are managed in the App console.

Authorizations

Authorization
string
header
required

Scoped X-Pilot API key

Headers

Idempotency-Key
string
required

Stable key for exact retries only. Use a different key for a different operation or input.

Required string length: 8 - 128

Body

application/json
text
string
required

Spoken text.

Maximum string length: 1000
Example:

"Welcome to our lesson."

voice_id
string
required

Catalog voice ID or owned ready clone ID.

voice_version
enum<integer>
default:1

Voice version of voice_id: Voice I (1, default) or Voice II (2). Never substitute one version for the other.

Available options:
1,
2
locale
string

Speech locale. Voice II catalog voices accept their native or secondary locales; Voice II clones accept the locales they support.

speed
number

Playback speed.

Required range: 0.5 <= x <= 2

Response

Success