API Overview

The ChatAgent API lets you build custom integrations, automate workflows, and access your data programmatically.

Base URL

https://api.chatagent.so/v1

Authentication

All API requests require authentication via API key:

Authorization: Bearer YOUR_API_KEY

Get your API key in Settings → API → Generate Key.

See Authentication for details.

Quick start

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

# Send a message
curl -X POST https://api.chatagent.so/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation_id": "conv_123",
    "message": "Thanks for your order!"
  }'

Core resources

Resource	Description
Conversations	List, search, and manage conversations
Messages	Send and retrieve messages
Contacts	Manage customer profiles
Orders	Access order data
Tags	Manage contact tags
Workflows	Trigger and manage automations

Rate limits

Plan	Requests/min
Free	60
Starter	120
Growth	300
Business	600
Enterprise	Custom

Webhooks

Receive real-time notifications when events happen in ChatAgent:

• New conversation
• Message received
• Order placed
• Conversation resolved

See Webhooks for setup details.

SDKs

Language	Package
JavaScript	npm install @chatagent/sdk
Python	pip install chatagent

Next steps

• Authentication — API keys and tokens
• Webhooks — receive real-time events
• API Reference — full endpoint documentation