Skip to main content
The Public API lets you access your agent’s conversations, analytics, customers, and more programmatically. All endpoints are authenticated with an API key and return JSON responses.
The Public API is available on Basic, Pro, and Scale plans.

API Reference (Swagger)

Browse the full API reference with request/response schemas and try endpoints directly.

​
Authentication

All API requests require a Bearer token in the Authorization header. The token is your agent’s API key.

​
Generate an API Key

1

Open Settings

Navigate to Settings → Security for your agent.
2

Generate Key

Click Generate API Key. Your key will be displayed once. Copy it immediately and store it securely.
3

Use the Key

Include the key as a Bearer token in the Authorization header of every API request.
Treat your API key like a password. It provides full read access to your agent’s data. If compromised, revoke it immediately from Settings → Security and generate a new one.

​
Rate Limits

The API allows 60 requests per 60 seconds per agent per IP address. If you exceed this limit, you’ll receive a 429 Too Many Requests response.

​
Endpoints

​
Agent

​
Chat

The chat endpoint accepts a message, optional conversationId to continue an existing conversation, and optional identity object for user tracking. Responses are streamed as Server-Sent Events with types: chunk, completed, tool_call, action_started, action_completed, error.

​
Conversations

Filters for listing conversations: page, limit (max 250), startDate, endDate, source (PREVIEW, EMBED, TELEGRAM, WHATSAPP, EMAIL), sentiment (POSITIVE, NEGATIVE, NEUTRAL), product, purchased (yes/no), customerId.

​
Analytics

Both endpoints accept optional from and to query parameters (ISO 8601 dates) to filter by date range.

​
Insights

​
Customers

Supports sortBy parameter: a-z, z-a, oldest, newest.

​
Knowledge

​
Orders

Supports skip (default 0) and take (1-250, default 20) query parameters.

​
Leads

​
Emails

​
Integrations