Skip to main content

​
Welcome to eigi.ai API

The eigi.ai API allows you to programmatically create, manage, and interact with AI voice agents. Build powerful integrations to automate calls, retrieve conversation data, and manage your voice agents at scale.

​
Base URL

All API requests should be made to: 
https://prod.eigi.ai/v1

​
Authentication

eigi.ai uses API Key authentication for public endpoints. Your API keys carry many privileges, so be sure to keep them secure and never expose them in client-side code or public repositories.

​
API Key Header

All API requests must include your API key in the X-API-Key header: 
curl https://prod.eigi.ai/v1/public/conversations \
  -H "X-API-Key: vk_your_api_key_here"

​
Getting Your API Key

  1. Log in to your eigi.ai Dashboard
  2. Navigate to Settings → API Keys
  3. Click Create New API Key
  4. Copy and securely store your API key (it will only be shown once)
Keep your API keys secure! Never commit them to version control or expose them in client-side code. Use environment variables or secure secret management systems.

​
API Key Format

API keys follow this format: 
vk_xxxxxxxxxxxxxxxxxxxxxxxx
All keys are prefixed with vk_ to help identify them in code and logs.

​
Authentication Flow

{
  "headers": {
    "X-API-Key": "vk_your_api_key_here",
    "Content-Type": "application/json"
  }
}

​
Error Responses

If authentication fails, you’ll receive one of these error responses:
Status CodeErrorDescription
401Missing API KeyThe X-API-Key header is not provided
401Invalid API KeyThe provided API key is not valid
401Inactive API KeyThe API key has been deactivated
401Expired API KeyThe API key has expired
403Unauthorized AccessYou don’t have permission to access this resource

​
Rate Limiting

API requests are rate limited to ensure fair usage and platform stability:
  • Free Tier: 100 requests per minute
  • Pro Tier: 500 requests per minute
  • Enterprise Tier: Custom limits
When you exceed the rate limit, you’ll receive a 429 Too Many Requests response with a Retry-After header indicating when you can make requests again.

​
API Endpoints

Get Conversation

Retrieve details of a specific conversation by ID

List Conversations

Get paginated list of conversations with filters

Outbound Call

Initiate outbound calls to phone numbers

​
Response Format

All API responses follow a consistent JSON format:

​
Success Response

{
  "status": "success",
  "data": {
    // Response data here
  },
  "message": "Operation completed successfully"
}

​
Error Response

{
  "detail": "Error message describing what went wrong"
}

​
Common HTTP Status Codes

Status CodeMeaningDescription
200OKRequest succeeded
201CreatedResource created successfully
400Bad RequestInvalid request parameters
401UnauthorizedAuthentication failed
403ForbiddenInsufficient permissions
404Not FoundResource not found
422Unprocessable EntityValidation error
429Too Many RequestsRate limit exceeded
500Internal Server ErrorServer error occurred

​
Need Help?

Support

Contact our support team

Dashboard

Manage your API keys and agents