
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.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.Update a bot
Modify an existing bot’s configuration.Delete a bot
Remove a bot permanently. This action cannot be undone.Bot status control
Toggle a bot’s active/inactive status without deleting it.Conversation endpoints
Retrieve and manage AI-powered conversations.List conversations
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
Delete a knowledge base entry
Voice AI call data
Retrieve call logs, transcripts, and analytics for Voice AI agents.List voice calls
Get call transcript
Get call recording
Webhook events
HoopAI sends webhook events for key AI-related activities. Configure webhook endpoints in Settings > Webhooks or via the API.Available AI events
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.