Skip to main content

​
Overview

The Annie API is a RESTful API that allows you to programmatically manage your AI voice agents, organizations, and conversations.

​
Base URL

https://api.helloannie.com/v1

​
Authentication

The Annie API supports two authentication methods:

​
API Keys

API Keys are long-lived tokens that can be generated from the Developer Portal. API keys are prefixed with annie-sk-v1- and should be included in the Authorization header. 
curl -H "Authorization: Bearer annie-sk-v1-xxxxx" https://api.helloannie.com/v1/bots

​
OAuth Tokens

OAuth tokens are short-lived access tokens generated using the OAuth 2.0 Client Credentials flow. These are ideal for server-to-server integrations. Token Endpoint: https://annie-external-api.us.auth0.com/oauth/token 
curl -X POST https://annie-external-api.us.auth0.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "your-client-id",
    "client_secret": "your-client-secret",
    "audience": "https://api.helloannie.com"
  }'

​
Response Format

All API responses follow this structure: 
{
  "success": true,
  "data": { },
  "message": "Optional message"
}

​
Rate Limiting

The default rate limit is 60 requests per minute per organization. When exceeded, the API responds with HTTP 429 Too Many Requests. Response headers include:
  • X-RateLimit-Limit: Maximum requests allowed
  • X-RateLimit-Remaining: Requests remaining in current window
  • X-RateLimit-Reset: When the window resets (UTC epoch seconds)

​
Explore the API

Bots

Create and manage AI voice agents

Organizations

Manage business locations and settings

Templates

Apply pre-built training configurations

Conversations

Access conversation history and messages