Quickstart

Step 1: Sign Up & Get Your API Key

1. Visit the platform and sign up for an account or log in if you already have an account.
2. Navigate to API Key tab in your account dashboard.
3. Create a new API Key and copy it.
4. Export the API Key in your environment with the name SMALLEST_API_KEY, ensuring that your application can access it securely for authentication.

Step 2: Install Dependencies

To install the required library:

$
pip install requests

Step 3: Make Your First API Call

Here is a basic example of how to use Python to transcribe an audio file:

1
import os
2
import requests
3
4
API_KEY = os.environ.get("SMALLEST_API_KEY")
5
6
response = requests.post(
7
    "https://waves-api.smallest.ai/api/v1/pulse/get_text",
8
    params={"model": "pulse", "language": "en"},
9
    headers={
10
        "Authorization": f"Bearer {API_KEY}",
11
        "Content-Type": "audio/wav",
12
    },
13
    data=open("audio.wav", "rb").read(),
14
    timeout=120
15
)
16
17
result = response.json()
18
print(result["transcription"])

Replace YOUR_API_KEY with the API key you obtained in Step 1.

Step 4: Explore More Features

• Real-Time Transcription: Stream audio via WebSocket for live transcription.
• Speaker Diarization: Identify and label different speakers in multi-speaker audio.
• Word Timestamps: Get precise timing information for each word.
• Emotion Detection: Analyze emotional tone in transcribed speech.

For detailed documentation on all available features and endpoints, visit our API Reference.

Need Help?

If you have any questions or need assistance, please contact our support team at support@smallest.ai.