For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI ReferenceClient LibrariesChangelog
DocumentationAPI ReferenceClient LibrariesChangelog
  • Introduction
    • Introduction
  • Getting Started
    • Quickstart
    • Models
    • Authentication
    • HTTP Streaming
  • Text to Speech
    • How to TTS
    • LLM to TTS
    • Voice Models & Languages
  • Voice Cloning
    • Types of Cloning
    • Voice Clone via UI
    • How to Voice Clone
    • Delete Cloned Voice
    • Professional Voice Cloning
  • Integrations
    • LiveKit
    • Plivo
    • Vonage
  • Product
    • Projects
  • Best Practices
    • Voice Cloning Best Practices
    • PVC Best Practices
    • TTS Best Practices
LogoLogo
Voice AgentsModels
Voice AgentsModels
On this page
  • API keys
  • Making Requests
  • Example API Request
  • Example with the Smallest Python Package
Getting Started

Authentication

||View as Markdown|
Was this page helpful?
Previous

Models

Next

HTTP vs HTTP Streaming vs Websockets

Built with

API keys

Smallest AI uses API keys for authentication. You must include your key with every API request to authenticate your identity and track usage against your quota.

Each API key can be scoped to the following:

  • Rate Limits: Controls the number of requests allowed within a specified time period.
  • Credit Quota: Defines the maximum usage credits available for your account.

Your API key is confidential and should be kept secure. Never share it with others or expose it in client-side code (browsers, mobile apps, github repositories, etc.).

Making Requests

All API requests require your key in the Authorization header using the Bearer key format:

Authorization: Bearer YOUR_API_KEY

Example API Request

Test the API with this curl command by replacing YOUR_API_KEY with your actual key:

$curl 'https://api.smallest.ai/waves/v1/lightning/get_voices' \
> -H 'Content-Type: application/json' \
> -H 'Authorization: Bearer YOUR_API_KEY'

Example with the Smallest Python Package

python
1from smallestai.waves import WavesClient
2
3# Initialize the client with your API key
4client = WavesClient(api_key="YOUR_API_KEY")
5
6# Retrieve available voices
7print(f"Available Voices: {client.get_voices(model='lightning')}")