Python API Routing for SpeechStream

SpeechStream offers a powerful Python API that allows developers to upload video data for processing. Whether you're building a transcription service, analyzing video content, or integrating speech recognition into your application, the SpeechStream API provides a flexible and efficient solution.

In this guide, we'll cover:

• Obtaining your API key
• Setting up your Python environment
• Uploading video data
• Handling API responses
• Understanding rate limits

Getting Started with the SpeechStream Python API

Obtaining Your API Key

To use the SpeechStream API, you'll first need to obtain an API key. This key authenticates your requests and ensures you have the necessary permissions.

1. Sign Up: If you haven't already, sign up for a SpeechStream account on our website.
2. Navigate to API Settings: Once logged in, go to your account settings and find the API Keys section.
3. Generate a New Key: Click on Generate New API Key. Make sure to store this key securely; it won't be shown again.

Note: Keep your API key confidential. Do not share it or include it in client-side code.

Setting Up Your Python Environment

Ensure you have Python 3.x installed on your machine. You'll also need the requests library to handle HTTP requests.

Install the requests library using pip:

pip install requests

Uploading Video Data

Here's how to upload a video file using the SpeechStream API:

import requests
 
API_KEY = 'your-api-key-here'
UPLOAD_URL = 'https://api.speechstream.example.com/v1/upload'
 
headers = {
    'Authorization': f'Bearer {API_KEY}'
}
 
files = {
    'file': open('path/to/your/video.mp4', 'rb')
}
 
response = requests.post(UPLOAD_URL, headers=headers, files=files)
 
if response.status_code == 200:
    print('Video uploaded successfully!')
    data = response.json()
    print('Processing ID:', data['processing_id'])
else:
    print('Upload failed.')
    print('Error:', response.text)

Replace 'your-api-key-here' with the API key you obtained earlier. This script uploads a video file to the SpeechStream API.

Handling API Responses

After uploading, the API responds with a processing_id. Use this ID to check the processing status:

import time
 
STATUS_URL = 'https://api.speechstream.example.com/v1/status'
 
processing_id = data['processing_id']
params = {'processing_id': processing_id}
 
while True:
    status_response = requests.get(STATUS_URL, headers=headers, params=params)
    status_data = status_response.json()
    
    if status_data['status'] == 'completed':
        print('Processing complete!')
        print('Transcription:', status_data['transcription'])
        break
    elif status_data['status'] == 'processing':
        print('Processing...')
        time.sleep(5)
    else:
        print('An error occurred:', status_data['message'])
        break

Understanding Rate Limits

To maintain optimal performance, SpeechStream imposes rate limits:

• Uploads: Up to 5 video uploads per minute.
• Status Checks: Limit to 1 request every 5 seconds per processing_id.

Exceeding these limits results in a 429 Too Many Requests error.

Handling Rate Limit Errors

if response.status_code == 429:
    print('Rate limit exceeded. Please wait and try again.')
    retry_after = int(response.headers.get('Retry-After', '60'))
    time.sleep(retry_after)

Best Practices

Efficient Uploads

• Compress Video Files: Reduce upload time by compressing videos before uploading.
• Chunked Uploads: For large files, consider implementing chunked uploads.

Secure API Key Storage

• Environment Variables: Store your API key in an environment variable.
• Configuration Files: Use config files that are excluded from version control.

Conclusion

Integrating SpeechStream's Python API allows you to harness powerful speech processing capabilities in your applications. Remember to handle your API key securely and be mindful of the rate limits to ensure seamless operation.

For more information, visit our API Documentation or contact Support.

By following this guide, you should now be able to upload and process video data using the SpeechStream Python API. Happy coding!

Additional Resources

• Pricing Plans