Skip to content
oHallo Developers
Search
Ctrl
K
Cancel
Overview
Introduction
Core Concepts
Authentication
Using the API
API Conventions
Conversations
Contacts and Accounts
Knowledge Base
Policies
Agents
Quality and CSAT
Consumption and Billing
Calendar and Bookings
Widgets
Channels
Webhooks
API Reference
Overview
Brands
Overview
List all brands
Get brand by ID
Workspaces
Overview
List workspaces
Get workspace by ID
Conversations
Overview
List conversations
Get conversation by ID
Get messages in a conversation
Get attachments in a conversation
Send a human reply
Resolve a conversation
Start a new outbound conversation
Take over a conversation
Release a conversation back to AI
Assign a conversation to a user
Unassign a conversation
Approve a pending action
Get conversation status counts
List attention items
Resolve an attention item
Contacts
Overview
Search contacts
Create a contact
Get contact by ID
Delete a contact
Update a contact
Link a contact to an account
Accounts
Overview
Search accounts
Get account by ID
List contacts for an account
Knowledge Base
Overview
List knowledge base entries
Create a KB entry
Search knowledge base entries
List pending KB entries
Delete a KB entry
Update a KB entry
Approve a pending KB entry
Reject a pending KB entry
Policies
Overview
List policy entries
Create a policy entry
Search policy entries
List pending policy entries
Delete a policy entry
Update a policy entry
Approve a pending policy entry
Reject a pending policy entry
API Keys
Overview
List API keys
Create an API key
Revoke an API key
Agents
Overview
List all agent definitions
List custom agent definitions
Create a custom agent
Delete a custom agent
Update a custom agent
Update agent instructions
List agent executions
List tool calls for an execution
MCP Connections
Overview
List MCP connections
Get MCP connection by ID
Test MCP connection health
Widgets
Overview
List KB widgets
Create a KB widget
Get a KB widget by ID
Delete a KB widget
Update a KB widget
Rotate KB widget public key
List contact form widgets
Create a contact form widget
Get a contact form widget by ID
Delete a contact form widget
Update a contact form widget
Rotate contact form widget public key
Channels
Overview
Get channel by ID
Delete a channel
Update a channel
Store channel credentials
Test channel connectivity
Retry channel provisioning
Quality
Overview
Get quality stats
Get conversation quality
Get account health
List circuit breakers
Acknowledge a circuit breaker
Resolve a circuit breaker
Get CSAT configuration
Update CSAT configuration
Billing
Overview
Get conversation statistics
Get agent breakdown
Get subscription
Create checkout session
List invoices
Get billing summary
Get pricing catalog
Calendar
Overview
List calendar connections
Get calendar connection
Delete calendar connection
Update calendar connection
List available calendars
Start OAuth flow
List bookings
MCP Servers
What is MCP?
Build an MCP Server
Tool Schema
Example: Shipping Tracker
Testing and Debugging
Guardrails
Identity and Verification
Overview
Verification Federation API (v2)
Authoring MCP tools for verification
Identity event schema
Lockout notification email template
Guides
Quickstart
Managing the Knowledge Base
Building a Custom Agent
Embedding Widgets
Overview
Copy as Markdown
Copied
API Keys
Section titled “API Keys”
Create, list, and revoke API keys.
