API Reference

What you'll learn

• Where to find the full AutoTalk API documentation
• How to authenticate requests with your API key
• Key API endpoints and what they do

AutoTalk exposes a public REST API that lets external applications create and manage clients, send messages, query conversations, work with dynamic data (Dynadata), and more. The API follows the OpenAPI 3.0 specification and uses API key authentication.

Live API documentation

The full, interactive API documentation is available at:

https://api.autotalk.io

From there you can browse every endpoint, see request and response schemas, and try out calls directly in the browser.

Authentication

All API requests require an API key passed in the x-api-key header:

x-api-key: YOUR_API_KEY

To generate an API key, go to Integrations > API Tokens in the AutoTalk dashboard and click the + button. See API Tokens for step-by-step instructions.

tip

Keep your API key secret. Never commit it to source control or share it in public channels. If a key is compromised, revoke it immediately and create a new one.

Base URL

All API requests use the following base URL:

https://api.autotalk.io/v1

Key endpoints

Below is an overview of the main API areas. For full request/response details, visit the live documentation.

Company

Method	Path	Description
GET	/v1/self	Retrieve the authenticated company's profile

Clients

Method	Path	Description
POST	/v1/contacts/{contactId}/send_message	Send a message to a specific contact

Conversations

Method	Path	Description
GET	/v1/conversations	List conversations
POST	/v1/conversations	Create a new conversation
POST	/v1/conversations/{id}/messages	Process messages in a conversation
GET	/v1/conversations/{id}/messages	List messages in a conversation

Dynadata (dynamic data)

Dynadata endpoints let you manage custom data entities (clients, orders, tickets, or any type your company defines).

Method	Path	Description
GET	/v1/dynadata/types	List all available Dynadata types
GET	/v1/dynadata/type/{type}/list	List items of a specific type
GET	/v1/dynadata/type/{type}/item/{_id}	Retrieve a single item by ID
POST	/v1/dynadata/type/{type}/create	Create a new item
PUT	/v1/dynadata/type/{type}/update	Update an existing item
POST	/v1/dynadata/type/{type}/validate	Validate an item without saving
GET	/v1/dynadata/type/{type}/schema	Get the JSON schema for a type
GET	/v1/dynadata/type/{type}/schema/zod	Get the Zod schema for a type
POST	/v1/dynadata/type/{type}/executeFunction/{functionName}	Execute a function on a type
POST	/v1/dynadata/type/{type}/item/{_id}/executeFunction/{functionName}	Execute a function on a specific item

Integrations and channels

Method	Path	Description
GET	/v1/integrations/channels	List connected integration channels

AI Assistants

Method	Path	Description
GET	/v1/assistants	List configured AI assistants

Example request

Here is an example of sending a text message to a client using curl:

curl -X POST https://api.autotalk.io/v1/contacts/CONTACT_ID/send_message \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Hello! How can we help you today?"
  }'

Next steps

• API Tokens -- Generate and manage your API keys
• Webhooks -- Receive event notifications from AutoTalk
• Workflows -- Automate tasks inside AutoTalk