Import Voice Profiles

Import voice profiles from third-party providers such as ElevenLabs.

Import Voice Profiles API Documentation

Import Voice Profiles API helper endpoint lets you import voices from other providers such as elevenlabs. This endpoint operates on a BYOK (Bring Your Own Key) basis, and as such, audio operations such as text-to-speech using imported voices are handled by the original provider and not Zoice Dev platform. You are not charged extra on Zoice for using these imported voices. It's worth noting that you need to first set up the credentials using POST /v1/byok endpoint to enable the integration and to further get the credential_id as a response to facilitate the voice imports.

API Request

To import a voice from a third-party provider, send a POST request to the /v1/voice-profiles/import endpoint with the information for the voice placed in the body of the request block. The required body parameters include provider_voice_id, provider, and credential_id associated to the BYOK integration.

Sending Request

bash
curl -X POST "https://api.zoice.com/v1/voice-profiles/import" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ZOICE_API_KEY" \
  -d '{
    "provider_voice_id": "728ae38a...",
	"provider": "elevenlabs",
    "credential_id": "53620347-d993-4451-"
  }'

Response Format

typescript
{
  "status": "success",
  "voice": {
    "voice_id": "3312660e-5b44-40ee...",
    "voice_name": "sophia",
    "preview_url": "https://storage.googleapis.com/eleven-353365a0-...mp3",
    "description": "Early middle aged woman",
    "age": "early-middle-aged",
    "gender": "female",
    "language": "en",
    "accent": "en-american",
    "voice_type": "imported",
    "voice_state": "active",
    "provider": "elevenlabs",
    "provider_voice_id": "6f6a1f06...",
    "credential_id": "cred_aad00e8e2446...",
    "created_at": "2026-09-10T10:26:49.028Z"
  }
}

Schema

Input

Body Parameter

Type

Required

Default

Range

provider_voice_id

string

Yes

-

-

provider

string

Yes

-

elevenlabs

credential_id

string (uuid)

Yes

-

-

Output

Field

Type

Description

status

string

The status of the API request.

Allowed values: "success", "processing", "failed"

voice

object

The imported voice profile object.

voice.voice_id

string (uuid)

The generated unique identifier for the imported voice.

voice.voice_name

string

The name of the imported voice.

voice.description

string

The description of the imported voice.

voice.age

string

The age category of the voice.

Allowed values: "child", "teen", "young-adult", "early-middle-aged", "late-middle-aged", "senior"

voice.gender

string

The gender of the voice.

Allowed values: "male", "female", "neutral"

voice.language

string

The primary language code for the voice profile (e.g., "en").

voice.accent

string

The specific accent regional variant (e.g., "en-american").

voice.voice_type

string

The type of the voice profile.

Allowed values: "private", "imported", "public"

voice.voice_state

string

The state of the voice profile.

Allowed values: "processing", "active"

voice.preview_url

string

The direct URL to an audio sample file for previewing the generated voice.

voice.provider

string

The original provider of the imported voice, for eg., elevenlabs.

voice.provider_voice_id

string

The unique identifier of the voice on the original provider.

voice.credential_id

string

The BYOK credential ID used for the import.

voice.created_at

string

Date and time of creation in UTC format.