Conversation AI Public API

What is the Conversation AI API?

The Conversation AI API provides developers with programmatic control over AI agents, actions, and conversation generations within your CRM. It enables you to automate agent setup, integrate with external applications, and export conversation data for analytics or compliance purposes—all without using the CRM's user interface.

Key Benefits of Using the Conversation AI API

Using the API offers several advantages for teams looking to scale their operations:

• Faster Onboarding: Automate agent creation and action attachment for new clients or locations in minutes.
• Scalable Configuration: Apply consistent agent settings and actions across multiple sub-accounts using scripts or automated workflows.
• Deeper Analytics: Retrieve detailed AI response data to power dashboards, quality assurance workflows, audits, and compliance exports.
• Flexible Integration: Connect your CRM with internal tools to trigger workflows, track outcomes, and log events externally.
• Least-Privilege Security: Use granular scopes to limit API access precisely to what your integration requires.

Authentication Methods

You can authenticate with the Conversation AI API using either Personal Integration Tokens (PIT) or JSON Web Tokens (JWT).

Personal Integration Tokens (PIT)

PIT tokens are quick to generate and scope. To create one:

1. Navigate to Settings → Private Integrations in your CRM sub-account.
2. Provide a name and description for the token.
3. Select the appropriate Conversation AI scopes.
4. Create the token and securely copy it for use.

JSON Web Tokens (JWT)

JWT supports OAuth-based application flows and is ideal for more complex integration scenarios.

API Endpoint Families

The API is organized into several endpoint families:

Actions

• Attach Action To Agent
• List Actions For An Agent
• Get Action By ID
• Update Action
• Remove Action From Agent
• Update Followup Settings

Agents

• Create An Agent
• Search Agents
• Update Agent
• Get Agent
• Delete Agent

Generations

• Get Generation Details

Frequently Asked Questions

Do I need a Sub-Account or Agency token for Conversation AI?

Use a Sub-Account token so API calls act within the correct location context.

Can I manage Conversation AI Agents through the API?

Yes. The API allows you to create, update, retrieve, and delete Conversation AI Agents programmatically.

Can I use both PIT and JWT?

Yes. Choose PIT for simple server-to-server integrations and JWT for OAuth app flows.

Where do I find the agentId?

Create or search agents via the Agents API, then use the returned id field in subsequent calls.

How do I audit AI responses programmatically?

Use the Generations endpoint to retrieve message-level response details and store them in your analytics or compliance system.

Why am I receiving a 403 error?

This is typically caused by missing scopes, incorrect permissions, or attempting to access resources outside the authorized Sub-Account.