API Overview

The Atlas API powers AI voice campaigns, SMS/web chat, payments, and customer management.

Base URL

All endpoints use the base URL:

https://api.youratlas.com/v1/api

Authentication

All API requests require an api-key header:

api-key: YOUR_API_KEY

Obtaining an API Key

1. Log in to the Atlas Portal
2. Navigate to Settings > API Keys
3. Click Create New Key
4. Copy the key — it will only be shown once

Example Request

$
curl --location 'https://api.youratlas.com/v1/api/campaign' \
>
  --header 'api-key: YOUR_API_KEY'

Scope

An API key grants access to all campaigns, call records, and knowledge base files within your Atlas account. There is currently no per-campaign key scoping. Keep your key secure and rotate it immediately if exposed.

Managing Your Keys

From the Atlas Portal under Settings > API Keys, you can:

• View your API key anytime
• Copy your key to the clipboard
• Regenerate your key if compromised
• Delete your key when no longer needed

Security Best Practices

• Never share your API key publicly
• Store keys securely using environment variables or secret management systems
• Rotate keys periodically if compromised
• Delete unused keys immediately

Error Handling

The API returns standard HTTP status codes:

Error responses follow this format:

1
{
2
  "statusCode": 400,
3
  "error": "Bad Request",
4
  "message": "Description of what went wrong"
5
}