Fetch Bulk Text-to-Speech Results

This endpoint streamlines the process of retrieving multiple completed audio files at once, perfect for applications that process batches of text-to-speech tasks. Instead of making individual requests for each run_id, you can efficiently gather all your generated audio files in a single API call.

​

How to Use this Endpoint

Retrieving multiple generated audio files is straightforward - make a POST request to this endpoint with an array of run_id values in the request body. The system will process all your completed tasks and return URLs for each audio file, making it easy to download or reference them in your application.

​

Understanding the Response

This endpoint returns a JSON response containing file URLs for each successfully processed run_id. Each audio file URL in the response corresponds to a completed text-to-speech task, allowing you to efficiently handle multiple audio files without the overhead of individual requests.

The bulk response structure provides:

• Organized Results: Each run_id is mapped to its corresponding audio file URL.
• Error Handling: Clear indication of any failed or unavailable runs.
• Efficient Processing: Single request handles multiple audio files.

​

Request Format

The request body should contain an array of run_id values for the completed text-to-speech tasks you want to retrieve:

{
  "run_ids": [12345, 12346, 12347, 12348]
}

​

Response Structure

The response will be a JSON object containing URLs for each successfully processed audio file:

{
    "12345": "https://audio-storage.camb.ai/files/audio_12345.flac",
    "12346": "https://audio-storage.camb.ai/files/audio_12346.flac",
    "12347": "https://audio-storage.camb.ai/files/audio_12347.flac",
    "12348": "https://audio-storage.camb.ai/files/audio_12348.flac"
}

​

Examples

​

Retrieving Multiple Audio Files

Here’s how to retrieve multiple generated audio files using Python:

import requests

# Your API authentication
headers = {
    "x-api-key": "your-api-key",  # Replace with your actual API key
    "Content-Type": "application/json",
}

# List of run_ids from your completed TTS tasks (must be between 2-5 run_ids)
run_ids = [12345, 12346, 12347, 12348]  # Replace with your actual run_ids


def get_bulk_audio_results(run_ids):
    """
    Retrieves URLs for multiple completed TTS tasks in a single request.

    Args:
        run_ids: List of run_id values for completed TTS tasks (must be 2-5 items)

    Returns:
        dict: Dictionary mapping run_ids to their audio file URLs
    """
    # Validate the number of run_ids
    if len(run_ids) < 2 or len(run_ids) > 5:
        print(
            f"Error: Must provide between 2 and 5 run_ids. You provided {len(run_ids)}."
        )
        return {}

    print(f"Retrieving audio URLs for {len(run_ids)} completed tasks...")

    # Prepare the request payload
    payload = {"run_ids": run_ids}

    try:
        # Make the POST request
        response = requests.post(
            "https://client.camb.ai/apis/tts-results",
            headers=headers,
            json=payload,
        )

        # Check if the request was successful
        response.raise_for_status()

        # Parse the response
        results = response.json()

        print(f"Successfully retrieved {len(results)} audio file URLs!")
        return results

    except requests.exceptions.RequestException as e:
        print(f"Error retrieving bulk audio results: {e}")
        return {}


# Retrieve all audio URLs
audio_urls = get_bulk_audio_results(run_ids)

# Process the results
for run_id, output_json in audio_urls.items():
    print(f"Run ID {run_id}: {output_json.get('output_url')}")

​

Best Practices

​

Request Size Requirements

This endpoint requires a specific batch size for optimal performance and resource management:

• Minimum: You must provide at least 2 run_id values per request
• Maximum: You can provide up to 5 run_id values per request
• Validation: Requests outside this range will be rejected with a validation error

​

Handling Larger Datasets

If you have more than 5 completed TTS tasks to retrieve:

• Split into Multiple Requests: Divide your run_id list into chunks of 2-5 items
• Sequential Processing: Process chunks sequentially to avoid rate limiting
• Batch Management: Implement logic to group your run_ids efficiently

​

Next Steps

With your bulk audio retrieval capabilities in place, you can:

1. Build Efficient Workflows: Process multiple audio files simultaneously in your applications
2. Create Batch Processing Systems: Handle large-scale content generation with minimal API overhead
3. Implement Robust Error Handling: Ensure your application gracefully handles partial failures
4. Optimize Resource Usage: Reduce API calls and improve application performance

This bulk endpoint provides the foundation for scalable voice applications that can handle multiple audio files efficiently and reliably.