Authentication

All ChatAgent API requests require authentication. Use an API key to authenticate.

Getting an API key

1. Log in to app.chatagent.so
2. Go to Settings → API
3. Click Generate API Key
4. Copy the key (shown once — store it securely)

Using the key

Include the key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Example: cURL

curl -X GET https://api.chatagent.so/v1/conversations \
  -H "Authorization: Bearer ghp_xxxxxxxxxxxx"

Example: JavaScript

const response = await fetch("https://api.chatagent.so/v1/conversations", {
  headers: {
    "Authorization": "Bearer ghp_xxxxxxxxxxxx",
  },
});
const data = await response.json();

Example: Python

import requests

response = requests.get(
    "https://api.chatagent.so/v1/conversations",
    headers={"Authorization": "Bearer ghp_xxxxxxxxxxxx"}
)
data = response.json()

Key types

Type	Permissions	Use case
Full access	Read + write	Server-side integrations
Read-only	Read only	Dashboards and reporting
Webhook	Event delivery	Webhook verification

Security

• Keep keys secret — never expose in client-side code or public repos
• Rotate regularly — regenerate keys periodically
• Use least privilege — use read-only keys when write access isn’t needed
• Monitor usage — check Settings → API for unusual activity

Revoking a key

1. Go to Settings → API
2. Find the key you want to revoke
3. Click Revoke
4. Confirm

Revoking a key immediately disables all integrations using it. Update your applications with the new key.

Error responses

Status	Meaning
401	Invalid or missing API key
403	Key doesn’t have permission for this action
429	Rate limit exceeded

Next steps

• Webhooks — receive real-time events
• API Overview — getting started
• API Reference — full endpoint docs