Zoice For Developers | Zoice API

Get Voice Profile API Docs

GET /v1/voice-profiles/{voice_id} helper endpoint lets you get a specific voice object matching the given voice_id value in the path parameter.

API Request

To retrieve the metadata of a specific voice associated with a voice_id, use the voice_id value as a path parameter in your request.

Sending Request

bash

curl -X GET "https://api.zoice.com/v1/voice-profiles/b92d8cc4-f3fa-4624..." \
  -H "Authorization: Bearer $ZOICE_API_KEY"

Response Format

json

{
  "status": "success",
  "voice": {
    "voice_id": "bedf6a57-c6a5-47c0-...",
    "voice_name": "Sophia",
    "description": "early middle aged woman",
    "age": "early-middle-aged",
    "gender": "female",
    "language": "en",
    "accent": "en-american",
	"voice_type": "private",
	"voice_state": "active",
	"preview_url": "https://storage.zoice.com/api/assets/audio-c018ff3d-691f-425a.mp3",
    "generation_info": {
      "reference_audio_urls": [
        "https://storage.zoice.com/api/assets/audio-ddc61733-0ed9-4b05-b03b...mp3"
      ]
    },
    "created_at": "2026-07-18T15:20:20.224Z"
  }
}

Schema

Input

Path Parameter	Type	Required	Default	Range
voice_id	string	Yes	-	a valid UUID string

Output

Field	Type	Description
status	string	The status of the API request. Allowed values: `"success"`, `"processing"`, `"failed"`
voice	object	The metadata of the voice.
voice.voice_id	string (uuid)	The unique identifier for the generated voice profile.
voice.voice_name	string	The name assigned to the voice profile.
voice.description	string	A brief description of the voice's characteristics.
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.generation_info	object	The object containing the information regarding voice profile generation.
voice.generation_info.reference_audio_urls	string[]	String array including the URLs to the input audio used for generating the audio profile.
voice.generation_info.preview_text	string	The custom text provided to generate audio preview.
voice.provider	string	The provider of the imported voice. For eg., `elevenlabs`.
voice.provider_voice_id	string	The original unique ID of the imported voice on the provider platform like ElevenLabs.
voice.credential_id	string	The credential ID associated to the imported voice.
voice.created_at	string	Date and time of creation in UTC format.