API Reference

Comprehensive guide to integrating with the YourAIVoice.ai API

Quick Start

Get started with the YourAIVoice.ai API in minutes

1. Generate an API Key

Navigate to Settings → API Keys and create a new API key.

2. Make your first request

curl https://youraivoice.ai/api/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

3. Start building

Explore the endpoints below and integrate our API into your application.

Authentication

All API requests require authentication using an API key

API Key Authentication

Include your API key in the Authorization header with the Bearer scheme:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

API rate limits are enforced to ensure fair usage

General API

100

requests per 15 minutes

AI Operations

10

requests per minute

API Endpoints

Available endpoints and their usage

GET
/api/entities

List all entities for the authenticated user

curl https://youraivoice.ai/api/entities \
  -H "Authorization: Bearer YOUR_API_KEY"
View Response
{
  "entities": [
    {
      "id": "uuid",
      "name": "Product Name",
      "slug": "product-name",
      "type": "product",
      "published": true,
      "createdAt": "2025-01-01T00:00:00Z"
    }
  ]
}
POST
/api/entities

Create a new entity

curl -X POST https://youraivoice.ai/api/entities \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Product",
    "slug": "my-product",
    "type": "product",
    "description": "Product description",
    "category": "Technology"
  }'
GET
/api/entities/[id]

Get a specific entity by ID

PUT
/api/entities/[id]

Update an existing entity

DELETE
/api/entities/[id]

Delete an entity

Error Handling

Understanding API error responses

401

Unauthorized

Invalid or missing API key

403

Forbidden

Subscription limit exceeded

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Something went wrong on our end

Need Help?

If you have questions or need assistance with the API, we're here to help.

View DocumentationContact Support