Conversation AI Public API

GHL Customer Care’s Conversation AI API gives developers programmatic control over AI agents, actions, and conversation generations. Use secure tokens and granular scopes to automate agent setup, integrate with external apps, and export conversation data for analytics or compliance. This guide explains what the API is, the benefits, authentication options (PIT & JWT), endpoint families, and step-by-step setup with screenshots.

youtube

TABLE OF CONTENTS

• What is the Conversation AI API?
• Key Benefits of Conversation AI API
• Authentication (PIT & JWT)
• API Documentation
  • Actions
  • Agents
  • Generations
• Frequently Asked Questions

What is the Conversation AI API?

Conversation AI API exposes the same core capabilities available in the Conversation AI UI (creating and managing agents, attaching actions, and pulling AI response details) so your team can automate configuration and connect Conversation AI to your own systems. Using this API, you can provision agents at scale, script action updates, and retrieve message-level generation data for reporting and audits.

This API is ideal for agencies, SaaS businesses, and developers who need to scale Conversation AI management beyond the GHL Customer Care user interface.

What You Can Do with the Conversation AI Public API

Using the API, you can:

• Create and manage Conversation AI Agents
• Configure and update AI Actions programmatically
• Retrieve AI conversation generation data
• Automate large-scale AI setup across sub-accounts
• Integrate Conversation AI with external applications
• Build custom reporting and compliance workflows

Key Benefits of Conversation AI API

Understanding practical benefits helps you decide when to use the API versus the UI. These points highlight the outcomes teams typically automate: faster provisioning, consistent configuration at scale, and reliable access to detailed conversation data.

• Faster onboarding: Automate agent creation and action attachment for new locations or clients in minutes.
• Scalable configuration: Apply consistent agent settings and actions across many sub-accounts via scripts or CI/CD jobs.
• Deeper analytics: Retrieve generations (AI response details) to power dashboards, QA workflows, audits, and compliance exports.
• Flexible integration: Orchestrate GHL Customer Care with your internal tools—trigger workflows, track outcomes, and log events externally.
• Least‑privilege security: Use read-only or write scopes to limit access precisely to what your integration needs.

Authentication (PIT & JWT)

Choosing the right auth method ensures reliable, secure access. Personal Integration Tokens (PIT) are quick to generate and scope, while JSON Web Tokens (JWT) support OAuth-based app flows. Both can be used for Conversation AI API access.

Open Settings → Private Integrations in your GHL Customer Care sub‑account (location).

Screenshot

Give it basic info (name and description).

Select the Conversation AI scopes.

Screenshot

Create the token and make a copy of it.

Screenshot

Maintain and use the token appropriately.

Screenshot

API Documentation

View the full API Documentation here Marketplace API 2.0 Conversation AI Actions

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

Q: Do I need a Sub‑Account or Agency token for Conversation AI? 

A: Use a Sub‑Account token so calls act within the correct location context.

Q. Can I manage Conversation AI Agents through the API?

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

Q: Can I use both PIT and JWT? 

A: Yes. You can authenticate with either method. Choose PIT for simple server‑to‑server integrations; use JWT for OAuth app flows.

Q: Where do I find the agentId? 

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

Q: How do I audit AI responses programmatically? 

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

Q. 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.