> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.hams.ai/platform/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.hams.ai/_mcp/server.

# Voice AI Platform

## Docs

- [Overview](https://docs.hams.ai/platform/overview.md): What the Voice AI Platform API covers, where it runs, and which key each part takes.
- [Authentication](https://docs.hams.ai/platform/authentication.md): The two kinds of API key, the header that carries each, and which endpoints take which.
- [API conventions](https://docs.hams.ai/platform/conventions.md): Pagination, the error format, rate limits, caching and CORS, as they apply to every endpoint.
- [Agent builder](https://docs.hams.ai/platform/agents/overview.md): The kinds of AI agent you can build, and how to choose between them.
- [Single Prompt](https://docs.hams.ai/platform/agents/single-prompt.md): One set of instructions handles the whole conversation. The quickest agent to build, and the most forgiving.
- [Conversation Flow](https://docs.hams.ai/platform/agents/conversation-flow.md): Draw the conversation as a flow, and control exactly when it moves from one step to the next.
- [Multi-Prompt (Squad)](https://docs.hams.ai/platform/agents/squad.md): Combine agents you have already built into one, and let them hand the caller to each other.
- [Agent settings](https://docs.hams.ai/platform/agents/settings.md): Every panel on an agent — what it controls, what the values mean, and which ones matter.
- [Tools](https://docs.hams.ai/platform/agents/tools.md): The actions an agent can take beyond talking, and how to build each kind.
- [Knowledge bases](https://docs.hams.ai/platform/agents/knowledge.md): Give an agent your documents to answer from, instead of writing everything into its prompt.
- [Alerts](https://docs.hams.ai/platform/agents/alerts.md): Be told the moment a pattern you care about appears in an agent's calls, instead of finding it later on a dashboard.
- [API keys](https://docs.hams.ai/platform/api-keys.md): Get a secret key for your servers or a public key for your pages, and restrict what each may do.
- [AI agents](https://docs.hams.ai/platform/ai-agents.md): Agents are built and updated in the HAMS platform; this is what you need from there to integrate with them.
- [Chat sessions and widget](https://docs.hams.ai/platform/chat.md): Start a chat with an agent, stream its replies, rate and end the session, and configure the embeddable widget.
- [Outbound batches](https://docs.hams.ai/platform/outbound-batches.md): Upload leads, schedule and publish a batch, and follow each lead to its outcome.
- [Outbound dialer](https://docs.hams.ai/platform/outbound-dialer.md): How a published batch becomes calls, what each lead status means, and the settings operators can tune.
- [SIP connection](https://docs.hams.ai/platform/integration/sip.md): Connect your PBX to Cloud Call Center with a SIP trunk, and learn which ports and limits apply.
- [IPsec VPN](https://docs.hams.ai/platform/integration/ipsec-vpn.md): Connect your firewall to Hams with an IPsec tunnel, and learn which traffic the tunnel carries.

## API Docs

- API Reference > AI Agents Chat [Init Chat Session](https://docs.hams.ai/platform/reference/ai-agents-chat/init-chat-session-ai-agents-agent-id-chat-init-post.md)
- API Reference > AI Agents Chat [Stream Chat](https://docs.hams.ai/platform/reference/ai-agents-chat/stream-chat-ai-agents-agent-id-chat-stream-post.md)
- API Reference > AI Agents Chat [End Chat](https://docs.hams.ai/platform/reference/ai-agents-chat/end-chat-ai-agents-agent-id-chat-call-id-end-post.md)
- API Reference > AI Agents Chat [Rate Chat](https://docs.hams.ai/platform/reference/ai-agents-chat/rate-chat-ai-agents-agent-id-chat-call-id-rate-post.md)
- API Reference > AI Agents Chat [Chat Status](https://docs.hams.ai/platform/reference/ai-agents-chat/chat-status-ai-agents-agent-id-chat-call-id-status-get.md)
- API Reference > AI Agent Widget Config [Get Widget Config](https://docs.hams.ai/platform/reference/ai-agent-widget-config/get-widget-config-ai-agents-agent-id-widget-config-get.md)
- API Reference > AI Agent Widget Config [Upsert Widget Config](https://docs.hams.ai/platform/reference/ai-agent-widget-config/upsert-widget-config-ai-agents-agent-id-widget-config-put.md)
- API Reference > Outbound Batch [List Batches](https://docs.hams.ai/platform/reference/outbound-batch/list-batches-outbound-batch-batches-get.md)
- API Reference > Outbound Batch [Create Batch](https://docs.hams.ai/platform/reference/outbound-batch/create-batch-outbound-batch-batches-post.md)
- API Reference > Outbound Batch [Get Batch](https://docs.hams.ai/platform/reference/outbound-batch/get-batch-outbound-batch-batches-batch-id-get.md)
- API Reference > Outbound Batch [Delete Batch](https://docs.hams.ai/platform/reference/outbound-batch/delete-batch-outbound-batch-batches-batch-id-delete.md)
- API Reference > Outbound Batch [List Leads](https://docs.hams.ai/platform/reference/outbound-batch/list-leads-outbound-batch-batches-batch-id-leads-get.md)
- API Reference > Outbound Batch [Add Leads](https://docs.hams.ai/platform/reference/outbound-batch/add-leads-outbound-batch-batches-batch-id-leads-post.md)
- API Reference > Outbound Batch [Publish Batch](https://docs.hams.ai/platform/reference/outbound-batch/publish-batch-outbound-batch-batches-batch-id-publish-post.md)
- API Reference > Outbound Batch [Stop Batch](https://docs.hams.ai/platform/reference/outbound-batch/stop-batch-outbound-batch-batches-batch-id-stop-post.md)
- API Reference > AI Agents Chat Public [Public Init Chat](https://docs.hams.ai/platform/reference/ai-agents-chat-public/public-init-chat-v-1-ai-agents-agent-id-chat-init-post.md)
- API Reference > AI Agents Chat Public [Public Stream Chat](https://docs.hams.ai/platform/reference/ai-agents-chat-public/public-stream-chat-v-1-ai-agents-agent-id-chat-stream-post.md)
- API Reference > AI Agents Chat Public [Public End Chat Session](https://docs.hams.ai/platform/reference/ai-agents-chat-public/public-end-chat-session-v-1-ai-agents-agent-id-chat-call-id-end-post.md)
- API Reference > AI Agents Chat Public [Public Rate Chat Session](https://docs.hams.ai/platform/reference/ai-agents-chat-public/public-rate-chat-session-v-1-ai-agents-agent-id-chat-call-id-rate-post.md)
- API Reference > AI Agents Chat Public [Public Chat Status](https://docs.hams.ai/platform/reference/ai-agents-chat-public/public-chat-status-v-1-ai-agents-agent-id-chat-call-id-status-get.md)
- API Reference > AI Agent Widget Config Public [Public Get Widget Config](https://docs.hams.ai/platform/reference/ai-agent-widget-config-public/public-get-widget-config-v-1-ai-agents-agent-id-widget-config-get.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.hams.ai/openapi.json)
- [OpenAPI YAML](https://docs.hams.ai/openapi.yaml)