Conversation AI Overview

The Conversation AI API lets you create and manage AI agents that automatically handle conversations with contacts. Use it to configure agent behaviors, attach custom actions (such as booking appointments or triggering workflows), manage follow-up settings, and track AI-generated responses.

Base URL

https://services.leadconnectorhq.com

Authentication

All endpoints require a Bearer token and an API version header.

Authorization: Bearer <access_token>
Version: 2021-07-28

See OAuth 2.0 to obtain an access token.

OAuth scopes

Scope	Access
`conversation-ai.readonly`	Read agents, actions, and generation data
`conversation-ai.write`	Create, update, and delete agents and actions

Quick start

Search for existing Conversation AI agents in a location:

curl -X GET "https://services.leadconnectorhq.com/conversation-ai/agents/search?locationId=ve9EPM428h8vShlRW1KT" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

Endpoints

Method	Path	Description
`POST`	`/conversation-ai/agents`	Create a new AI agent
`GET`	`/conversation-ai/agents/search`	Search for agents
`GET`	`/conversation-ai/agents/{agentId}`	Get agent details
`PUT`	`/conversation-ai/agents/{agentId}`	Update an agent
`DELETE`	`/conversation-ai/agents/{agentId}`	Delete an agent
`POST`	`/conversation-ai/agents/{agentId}/actions`	Attach an action to an agent
`GET`	`/conversation-ai/agents/{agentId}/actions/list`	List agent actions
`GET`	`/conversation-ai/agents/{agentId}/actions/{actionId}`	Get action details
`PUT`	`/conversation-ai/agents/{agentId}/actions/{actionId}`	Update an action
`DELETE`	`/conversation-ai/agents/{agentId}/actions/{actionId}`	Remove an action
`PATCH`	`/conversation-ai/agents/{agentId}/followup-settings`	Update follow-up settings
`GET`	`/conversation-ai/generations`	Get generation details

Conversations API — Manage conversations where AI agents operate
Contacts API — Retrieve the contacts AI agents interact with
Workflows API — Trigger automated sequences from AI agent actions

Conversation AI

Agent Studio

Knowledge Base

Voice AI

Phone System

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related