# Kupe AI Documentation

## Docs

- [Create agent (defaults)](https://kupe.in/docs/api-reference/voice-agent/agent-management/create-agent-defaults.md): **Full URL:** `POST https://api.kupe.in/api/v1/agents/simple`
- [Delete agent](https://kupe.in/docs/api-reference/voice-agent/agent-management/delete-agent.md): **Full URL:** `DELETE https://api.kupe.in/api/v1/agents/{agent_id}` (optional `?force_delete=true`)
- [Get agent by ID](https://kupe.in/docs/api-reference/voice-agent/agent-management/get-agent-by-id.md): **Full URL:** `GET https://api.kupe.in/api/v1/agents/{agent_id}`
- [List agents](https://kupe.in/docs/api-reference/voice-agent/agent-management/list-agents.md): **Full URL:** `GET https://api.kupe.in/api/v1/agents` (optional query `?page=1&page_size=20&scope=all&q=…`)
- [Update agent](https://kupe.in/docs/api-reference/voice-agent/agent-management/update-agent.md): **Full URL:** `PUT https://api.kupe.in/api/v1/agents/{agent_id}` (optional `?force_update=true`)
- [Create API key](https://kupe.in/docs/api-reference/voice-agent/api-keys/create-api-key.md): **Full URL:** `POST https://api.kupe.in/api/v1/api-keys`
- [List active API keys](https://kupe.in/docs/api-reference/voice-agent/api-keys/list-active-api-keys.md): **Full URL:** `GET https://api.kupe.in/api/v1/api-keys/fetch`
- [Revoke API key](https://kupe.in/docs/api-reference/voice-agent/api-keys/revoke-api-key.md): **Full URL:** `DELETE https://api.kupe.in/api/v1/api-keys/{key_id}`
- [Update API key display name](https://kupe.in/docs/api-reference/voice-agent/api-keys/update-api-key-display-name.md): **Full URL:** `PATCH https://api.kupe.in/api/v1/api-keys/{key_id}`
- [Aggregated usage summary (charts)](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/aggregated-usage-summary-charts.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage/summary`
- [Current credit balance summary](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/current-credit-balance-summary.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/credit-balance`
- [Export usage (email CSV)](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/export-usage-email-csv.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage/export`
- [Service usage rows grouped by session](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/service-usage-rows-grouped-by-session.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage/records`
- [Usage and cost for one call session](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/usage-and-cost-for-one-call-session.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage/sessions/{session_id}`
- [Usage overview totals](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/usage-overview-totals.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage/overview`
- [Usage records organized by call sessions](https://kupe.in/docs/api-reference/voice-agent/billing-and-usage/usage-records-organized-by-call-sessions.md): **Full URL:** `GET https://api.kupe.in/api/v1/billing/usage-records` — credits/services per session.
- [Export call logs (ZIP)](https://kupe.in/docs/api-reference/voice-agent/call-logs/export-call-logs-zip.md): **Full URL:** `GET https://api.kupe.in/api/v1/call-analytics/export`
- [List or fetch call sessions (call logs)](https://kupe.in/docs/api-reference/voice-agent/call-logs/list-or-fetch-call-sessions-call-logs.md): **Full URL:** `GET https://api.kupe.in/api/v1/call-analytics`
- [List users](https://kupe.in/docs/api-reference/voice-agent/current-user/list-users.md): **Full URL:** `GET https://api.kupe.in/api/v1/me/users`
- [Me](https://kupe.in/docs/api-reference/voice-agent/current-user/me.md): **Full URL:** `GET https://api.kupe.in/api/v1/me`
- [My organization earnings breakdown](https://kupe.in/docs/api-reference/voice-agent/earnings/my-organization-earnings-breakdown.md): **Full URL:** `GET https://api.kupe.in/api/v1/earnings/me/breakdown` — time buckets; query `period`.
- [My organization earnings summary](https://kupe.in/docs/api-reference/voice-agent/earnings/my-organization-earnings-summary.md): **Full URL:** `GET https://api.kupe.in/api/v1/earnings/me` — reseller org (`channel_partner` / `distributor`); query `period`.
- [Organization earnings (super admin)](https://kupe.in/docs/api-reference/voice-agent/earnings/organization-earnings-super-admin.md): **Full URL:** `GET https://api.kupe.in/api/v1/earnings/orgs/{org_id}` — **super_admin** only; query `period`.
- [Map agent or workflow to a phone line](https://kupe.in/docs/api-reference/voice-agent/incoming-calls/map-agent-or-workflow-to-a-phone-line.md): **Full URL:** `POST https://api.kupe.in/api/v1/phone/mapping`
- [Attach file to agent](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/attach-file-to-agent.md): **Full URL:** `POST https://api.kupe.in/api/v1/agent-files-mappings/create`
- [Delete file](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/delete-file.md): **Full URL:** `DELETE https://api.kupe.in/api/v1/files/{file_id}`
- [Detach file from agent](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/detach-file-from-agent.md): **Full URL:** `DELETE https://api.kupe.in/api/v1/agent-files-mappings/agent/{agent_id}/file/{upload_file_id}`
- [Get file metadata](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/get-file-metadata.md): **Full URL:** `GET https://api.kupe.in/api/v1/files/{file_id}`
- [Hybrid search (RAG)](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/hybrid-search-rag.md): **Full URL:** `POST https://api.kupe.in/api/v1/search/hybrid?agent_id={uuid}`
- [List files attached to agent](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/list-files-attached-to-agent.md): **Full URL:** `GET https://api.kupe.in/api/v1/agent-files-mappings/agent/{agent_id}`
- [List files for authenticated user](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/list-files-for-authenticated-user.md): **Full URL:** `GET https://api.kupe.in/api/v1/files/user/me`
- [Semantic search (RAG)](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/semantic-search-rag.md): **Full URL:** `POST https://api.kupe.in/api/v1/search/semantic?agent_id={uuid}`
- [Supported upload formats](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/supported-upload-formats.md): **Full URL:** `GET https://api.kupe.in/api/v1/files/supported-formats`
- [Upload knowledge file](https://kupe.in/docs/api-reference/voice-agent/knowledge-base/upload-knowledge-file.md): **Full URL:** `POST https://api.kupe.in/api/v1/files/upload` (`multipart/form-data`)
- [Initiate outbound call](https://kupe.in/docs/api-reference/voice-agent/outbound-calls/initiate-outbound-call.md): **Full URL (query string, not JSON body):**   `POST https://api.kupe.in/api/call/create_call?phoneNumber=%2B15551234567&agent_id={uuid}`
- [Get all phone numbers](https://kupe.in/docs/api-reference/voice-agent/phone-numbers/get-all-phone-numbers.md): **Full URL:** `GET https://api.kupe.in/api/v1/phone`
- [Create post-call analysis rule](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/create-post-call-analysis-rule.md): **Full URL:** `POST https://api.kupe.in/api/v1/post-analysis/rules` — JSON body per backend.
- [Delete rule](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/delete-rule.md)
- [Duplicate rule](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/duplicate-rule.md)
- [Get one rule](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/get-one-rule.md)
- [Get post-call analysis config for agent](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/get-post-call-analysis-config-for-agent.md)
- [List attached rule IDs only](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/list-attached-rule-ids-only.md)
- [List post-call analysis rules](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/list-post-call-analysis-rules.md): **Full URL:** `GET https://api.kupe.in/api/v1/post-analysis/rules`
- [List rules attached to agent](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/list-rules-attached-to-agent.md)
- [Set attached rule IDs for agent](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/set-attached-rule-ids-for-agent.md): Body: `{ "rule_ids": ["uuid", ...] }`
- [Update rule](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/update-rule.md)
- [Upsert post-call analysis for agent](https://kupe.in/docs/api-reference/voice-agent/post-call-analysis/upsert-post-call-analysis-for-agent.md): Body must include fields aligned with backend `PostCallAnalysis` upsert; `agent_id` should match path.
- [List all provider tables](https://kupe.in/docs/api-reference/voice-agent/providers/list-all-provider-tables.md): **Full URL:** `GET https://api.kupe.in/api/v1/providers/all`
- [List LLM providers](https://kupe.in/docs/api-reference/voice-agent/providers/list-llm-providers.md): **Full URL:** `GET https://api.kupe.in/api/v1/providers/model`
- [List STT providers](https://kupe.in/docs/api-reference/voice-agent/providers/list-stt-providers.md): **Full URL:** `GET https://api.kupe.in/api/v1/providers/stt`
- [List TTS providers](https://kupe.in/docs/api-reference/voice-agent/providers/list-tts-providers.md): **Full URL:** `GET https://api.kupe.in/api/v1/providers/tts`
- [List TTS voice catalog rows](https://kupe.in/docs/api-reference/voice-agent/providers/list-tts-voice-catalog-rows.md): **Full URL:** `GET https://api.kupe.in/api/v1/tts-voices`
- [Health check (no API key)](https://kupe.in/docs/api-reference/voice-agent/service/health-check-no-api-key.md): **Full URL:** `GET https://api.kupe.in/health`
- [Add tools to an agent](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/add-tools-to-an-agent.md)
- [Create HTTP tool endpoint definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/create-http-tool-endpoint-definition.md): **Full URL:** `POST https://api.kupe.in/api/v1/tool-endpoint-defs` — body matches dashboard/API schemas (name, url, tool_schema, …).
- [Create MCP server tool definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/create-mcp-server-tool-definition.md)
- [Delete HTTP tool definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/delete-http-tool-definition.md)
- [Delete MCP server tool definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/delete-mcp-server-tool-definition.md)
- [Get HTTP tool definition by id](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/get-http-tool-definition-by-id.md)
- [Get MCP server tool definition by id](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/get-mcp-server-tool-definition-by-id.md)
- [List HTTP tool endpoint definitions](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/list-http-tool-endpoint-definitions.md): **Full URL:** `GET https://api.kupe.in/api/v1/tool-endpoint-defs`
- [List MCP server tool definitions](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/list-mcp-server-tool-definitions.md)
- [List tools attached to an agent](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/list-tools-attached-to-an-agent.md)
- [Remove one tool from an agent](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/remove-one-tool-from-an-agent.md)
- [Replace agent tools configuration](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/replace-agent-tools-configuration.md)
- [Update HTTP tool definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/update-http-tool-definition.md)
- [Update MCP server tool definition](https://kupe.in/docs/api-reference/voice-agent/tools-and-mcp/update-mcp-server-tool-definition.md)
- [My wallet summary](https://kupe.in/docs/api-reference/voice-agent/wallets/my-wallet-summary.md): **Full URL:** `GET https://api.kupe.in/api/v1/wallets/me` — authenticated user's wallet (balance, cap usage, metadata).
- [Wallet detail (grants and ledger)](https://kupe.in/docs/api-reference/voice-agent/wallets/wallet-detail-grants-and-ledger.md): **Full URL:** `GET https://api.kupe.in/api/v1/wallets/{wallet_id}` — grants, ledger entries, upcoming expiry (RBAC).
- [Call analysis error your https endpoint](https://kupe.in/docs/api-reference/voice-agent/webhooks/call-analysis-error-your-https-endpoint.md): Model failures or tool HTTP failures you surface from post-analysis pipelines.
- [Call completed your https endpoint](https://kupe.in/docs/api-reference/voice-agent/webhooks/call-completed-your-https-endpoint.md): **Inbound to your server.** Configure via agent **Post analysis** → HTTP integration / structured output. Map fields in your tool schema so Kupe’s POST matches this example.
- [Files](https://kupe.in/docs/assistants/files.md): Use uploaded files for question answering and context.
- [Integrations](https://kupe.in/docs/assistants/integrations.md): Connect external systems so your assistants can perform real tasks.
- [Model providers](https://kupe.in/docs/assistants/model-providers.md): How to reference LLM, TTS, and STT in the agent API, with logos and language-code conventions.
- [Model, Transcriber & TTS](https://kupe.in/docs/assistants/model-stt-tts.md): Configure the model, transcriber, and text-to-speech for your assistant.
- [Post Analysis](https://kupe.in/docs/assistants/post-analysis.md): Analyze completed calls for summaries, structured data, or follow-up actions.
- [Quickstart](https://kupe.in/docs/assistants/quickstart.md): Build your first voice assistant and make a call in minutes.
- [Testing](https://kupe.in/docs/assistants/testing.md): Test your assistant with web calls or chat before going live.
- [HTTP Integrations](https://kupe.in/docs/integrations/http_integrations.md): Connect agents and workflows to external APIs via HTTP.
- [MCP Integrations](https://kupe.in/docs/integrations/mcp_integrations.md): Connect and use MCP integrations for agents and workflows.
- [Integrations Overview](https://kupe.in/docs/integrations/overview.md): How integrations let agents perform complex tasks.
- [Introduction](https://kupe.in/docs/introduction.md): Welcome to Kupe AI
- [Batch Calling (Outbound)](https://kupe.in/docs/outbound/outbound.md): Run outbound call campaigns with agents or workflows.
- [Pipelines Overview](https://kupe.in/docs/pipeline-overview.md): How voice and text interactions flow in Kupe AI.

## OpenAPI Specs

- [kupe-voice-agent.openapi](https://kupe.in/docs/api-reference/kupe-voice-agent.openapi.yaml)
- [openapi](https://kupe.in/docs/api-reference/openapi.json)