API Reference

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://api.eigi.ai

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://api.eigi.ai/v1/public/conversations \
  -H "X-API-Key: vk_your_api_key_here"

Getting Your API Key

Log in to your eigi.ai Dashboard
Navigate to Settings → API Keys
Click Create New API Key
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 Code	Error	Description
`401`	Missing API Key	The `X-API-Key` header is not provided
`401`	Invalid API Key	The provided API key is not valid
`401`	Inactive API Key	The API key has been deactivated
`401`	Expired API Key	The API key has expired
`403`	Unauthorized Access	You 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 Code	Meaning	Description
`200`	OK	Request succeeded
`201`	Created	Resource created successfully
`400`	Bad Request	Invalid request parameters
`401`	Unauthorized	Authentication failed
`403`	Forbidden	Insufficient permissions
`404`	Not Found	Resource not found
`422`	Unprocessable Entity	Validation error
`429`	Too Many Requests	Rate limit exceeded
`500`	Internal Server Error	Server error occurred

Overview

Conversations

Chat

Prompts

Agents

Utilities

Welcome to eigi.ai API

Base URL

Authentication

API Key Header

Getting Your API Key

API Key Format

Authentication Flow

Error Responses

Rate Limiting

API Endpoints

Get Conversation

List Conversations

Outbound Call

Response Format

Success Response

Error Response

Common HTTP Status Codes

Need Help?

Support

Dashboard

​Welcome to eigi.ai API

​Base URL

​Authentication

​API Key Header

​Getting Your API Key

​API Key Format

​Authentication Flow

​Error Responses

​Rate Limiting

​API Endpoints

Get Conversation

List Conversations

Outbound Call

​Response Format

​Success Response

​Error Response

​Common HTTP Status Codes

​Need Help?

Support

Dashboard

Welcome to eigi.ai API

Base URL

Authentication

API Key Header

Getting Your API Key

API Key Format

Authentication Flow

Error Responses

Rate Limiting

API Endpoints

Response Format

Success Response

Error Response

Common HTTP Status Codes

Need Help?