Skip to main content
HoopAI’s AI features are not limited to the platform interface. Through the REST API, you can programmatically create and manage AI agents, retrieve conversation data, control bot status, manage knowledge bases, access Voice AI transcripts, and pull analytics. This reference covers the key endpoints, authentication, webhooks, and code examples you need to integrate AI capabilities into your own applications and workflows. For the full platform API documentation, see the API introduction.
Conversation AI agents list showing bots manageable through the API

The Conversation AI bot management interface accessible via the API

Authentication

All AI API requests require authentication using a Bearer token. You can generate API keys from Settings > Business Profile > API Keys in your HoopAI account. Every request must include the locationId parameter (either in the URL path or as a query parameter) to identify which HoopAI account the request applies to.
Never expose your API key in client-side code or public repositories. Store it in environment variables or a secrets manager.

API base URL and versioning

All endpoints described below are relative to the base URL.

Agent management endpoints

These endpoints let you create, read, update, and delete AI agents programmatically.

List all bots

Retrieve all Conversation AI bots for a account.

Get bot details

Retrieve configuration details for a specific bot.

Create a bot

Create a new Conversation AI bot with a system prompt and model configuration.
Request body:

Update a bot

Modify an existing bot’s configuration.

Delete a bot

Remove a bot permanently. This action cannot be undone.
Deleting a bot removes its configuration and knowledge base associations. Conversation history is retained on the contact record but will no longer be linked to the bot.

Bot status control

Toggle a bot’s active/inactive status without deleting it.
Request body:
Valid status values: active, inactive, draft.

Conversation endpoints

Retrieve and manage AI-powered conversations.

List conversations

Query parameters:

Get conversation messages

Retrieve all messages in a specific conversation, including both contact and AI messages.

Send a message

Inject a message into a conversation programmatically.

Knowledge base endpoints

Manage the documents and content your AI agents reference.

List knowledge base items

Add a knowledge base entry

You can add text entries (with a title and content body) or URL entries (providing a URL for the AI to crawl and index).

Delete a knowledge base entry

Voice AI call data

Retrieve call logs, transcripts, and analytics for Voice AI agents.

List voice calls

Query parameters:

Get call transcript

Returns the full transcript with timestamps, speaker labels, and sentiment scores for each segment.

Get call recording

Returns a signed URL to download the call recording (valid for 24 hours).

Webhook events

HoopAI sends webhook events for key AI-related activities. Configure webhook endpoints in Settings > Webhooks or via the API.

Available AI events

Use webhook events to trigger external workflows — for example, create a ticket in your help desk when a conversation is escalated, or log Voice AI call data to a business intelligence dashboard.

Rate limits

HoopAI’s API enforces rate limits to ensure platform stability. When you exceed the rate limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how long to wait.

Error handling

The API uses standard HTTP status codes. Common error responses:
For 500 errors, wait 30 seconds and retry. If the error persists, check the HoopAI status page or contact support.

Next steps

API introduction

Full HoopAI platform API documentation and authentication guide.

AI actions in workflows

Use AI within workflows without writing API code.

Bot settings

Configure AI agents through the platform interface.

AI migration

Migrate AI configurations between accounts and platforms.
Last modified on March 7, 2026