Skip to main content
GET
/
api
/
v1
/
assistants
/
{assistant_id}
/
voice-samples
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint retrieves a list of all voice samples that have been uploaded for a specific assistant’s organization.

​
Path Parameters

  • assistant_id (integer, required): The unique identifier of the assistant whose voice samples you want to list.

​
Query Parameters

  • status (string, optional): Filter voice samples by processing status.
    • Allowed values: uploaded, processing, ready, failed

​
Response

The response is a JSON object containing an array of voice sample objects.
Response
{
  "success": true,
  "voice_samples": [
    {
      "id": 123,
      "name": "Professional Voice Sample",
      "original_filename": "professional_voice.wav",
      "content_type": "audio/wav",
      "file_size": 2457600,
      "duration_seconds": 45.2,
      "status": "ready",
      "error_message": null,
      "tags": ["professional", "clear", "business"],
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 124,
      "name": "Casual Voice Sample",
      "original_filename": "casual_voice.mp3",
      "content_type": "audio/mpeg",
      "file_size": 1843200,
      "duration_seconds": 32.1,
      "status": "uploaded",
      "error_message": null,
      "tags": ["casual", "friendly"],
      "created_at": "2024-01-15T11:15:00Z"
    }
  ]
}

​
Response Fields

  • id (integer): Unique identifier for the voice sample
  • name (string): Display name of the voice sample
  • original_filename (string): Original filename of the uploaded audio
  • content_type (string): MIME type of the audio file
  • file_size (integer): Size of the audio file in bytes
  • duration_seconds (float): Duration of the audio in seconds
  • status (string): Processing status of the sample
  • error_message (string): Error message if processing failed
  • tags (array): Array of tags associated with the sample
  • created_at (string): ISO 8601 timestamp of when the sample was uploaded

​
Status Values

  • uploaded: Sample uploaded successfully, ready for voice cloning
  • processing: Sample is being processed (validation, analysis)
  • ready: Sample processed and available for voice cloning
  • failed: Sample processing failed, check error_message

​
Example Request

cURL
curl -X GET "https://api.burki.dev/api/v1/assistants/123/voice-samples?status=ready" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
assistant_id
integer
required

Query Parameters

​
status
string | null

Filter by status

Response

Successful Response