API Basics
Get started with the Your AI Voice API to programmatically manage your LLM-ready content
Professional Plan Required
API access is available on Professional, Business, and Enterprise plans.Upgrade your plan
Getting Started
Quick start guide to using the API
1. Create an API Key
Navigate to your API Keys page and create a new API key. Save it securely - you won't be able to see it again!
2. Base URL
https://youraivoice.ai/api3. Authentication
Include your API key in the Authorization header with every request:
Authorization: Bearer yav_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
4. Make Your First Request
Try listing your entities:
curl -X GET \ https://youraivoice.ai/api/entities \ -H "Authorization: Bearer YOUR_API_KEY"
Request Format
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | Yes |
Content-Type | application/json | POST/PUT only |
Response Format
All responses are returned in JSON format:
{
"success": true,
"data": { ... },
"message": "Operation completed successfully"
}Error Response
{
"error": "Error message",
"details": "Additional error details"
}Rate Limits
| Plan | Rate Limit |
|---|---|
| Professional | 100 requests/hour |
| Business | 500 requests/hour |
| Enterprise | 5,000 requests/hour |
Rate limit information is included in response headers:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95