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
name
string
required

Voice title.

Maximum string length: 80
audio_url
string
required

Owned uploaded training audio URL. Voice II: 5–90 seconds of the same speaker.

cover_image_url
string

Optional owned uploaded cover image URL. Voice I only.

voice_version
enum<integer>
default:1

Voice I (1, default) or Voice II (2, consent-based personal voice).

Available options:
1,
2
voice_talent_name
string

Voice II only: the speaker's name exactly as spoken in the consent recording.

Maximum string length: 128
locale
string

Voice II only: recording locale from get_voice_clone_config, for example en-US or zh-CN.

Maximum string length: 16

Voice II only: owned uploaded recording of the speaker reading the consent_statement for locale. Must be a separate file from audio_url, at most 90 seconds.

Voice II only: true when the speaker has explicitly agreed that their voice may be cloned. Required for Voice II.

Available options:
true,
false

Response

Success