# Truedy API Documentation

## Docs

- [Create Agent](https://docs.truedy.ai/api-reference/agents/create-agent.md): Create a new voice AI agent with system instructions and voice configuration.
- [Delete Agent](https://docs.truedy.ai/api-reference/agents/delete-agent.md): Delete an agent permanently. This action cannot be undone.
- [Get Agent](https://docs.truedy.ai/api-reference/agents/get-agent.md): Retrieve detailed information about a specific agent.
- [List Agents](https://docs.truedy.ai/api-reference/agents/list-agents.md): Retrieve all voice AI agents in your organization with optional filtering.
- [Trigger Test Call](https://docs.truedy.ai/api-reference/agents/trigger-test-call.md): Initiate a test phone call using this agent to verify its configuration before going live. The call behaves exactly like a production call.
- [Update Agent](https://docs.truedy.ai/api-reference/agents/update-agent.md): Update an existing agent with new configuration.
- [Add Contacts to Batch Call](https://docs.truedy.ai/api-reference/batch-calls/add-contacts-to-batch-call.md): Add new contacts to an existing batch calling campaign.
- [Bulk Delete Batch Calls](https://docs.truedy.ai/api-reference/batch-calls/bulk-delete-batch-calls.md): Delete multiple batch calling campaigns at once.
- [Create Batch Call](https://docs.truedy.ai/api-reference/batch-calls/create-batch-call.md): Create a new batch calling campaign with contacts, scheduling, and configuration.
- [Delete Batch Call](https://docs.truedy.ai/api-reference/batch-calls/delete-batch-call.md): Delete a batch calling campaign.
- [Get Batch Call](https://docs.truedy.ai/api-reference/batch-calls/get-batch-call.md): Retrieve details about a specific batch calling campaign.
- [Get Batch Call Analytics](https://docs.truedy.ai/api-reference/batch-calls/get-batch-call-analytics.md): Retrieve detailed analytics and statistics for a batch calling campaign.
- [List Batch Call Contacts](https://docs.truedy.ai/api-reference/batch-calls/list-batch-call-contacts.md): Retrieve contacts in a batch calling campaign with their call status.
- [List Batch Calls](https://docs.truedy.ai/api-reference/batch-calls/list-batch-calls.md): Retrieve all batch calling campaigns.
- [Pause Batch Call Campaign](https://docs.truedy.ai/api-reference/batch-calls/pause-batch-call-campaign.md): Pause a running campaign. Calls already connected will complete. No new calls will start until resumed.
- [Resume Batch Call Campaign](https://docs.truedy.ai/api-reference/batch-calls/resume-batch-call-campaign.md): Resume a paused batch call campaign. Calling continues from where it left off.
- [Schedule Batch Call](https://docs.truedy.ai/api-reference/batch-calls/schedule-batch-call.md): Schedule a batch call campaign to begin at a future time, or start it immediately by omitting `scheduled_at`.
- [Update Batch Call](https://docs.truedy.ai/api-reference/batch-calls/update-batch-call.md): Update batch call settings (only when status is draft).
- [Create Call](https://docs.truedy.ai/api-reference/calls/create-call.md): Create a new outbound call to a phone number using an agent.
- [Delete Call](https://docs.truedy.ai/api-reference/calls/delete-call.md): Delete a call record. Note: Active calls cannot be deleted.
- [Get Call](https://docs.truedy.ai/api-reference/calls/get-call.md): Retrieve detailed information about a specific call.
- [List Calls](https://docs.truedy.ai/api-reference/calls/list-calls.md): Retrieve a list of calls with optional filtering and pagination.
- [Update Call](https://docs.truedy.ai/api-reference/calls/update-call.md): Update call settings or context variables.
- [Create Contact](https://docs.truedy.ai/api-reference/contacts/create-contact.md): Create a new contact with phone number and optional metadata.
- [Create Contact Folder](https://docs.truedy.ai/api-reference/contacts/create-contact-folder.md): Create a new folder to organize contacts.
- [Delete Contact](https://docs.truedy.ai/api-reference/contacts/delete-contact.md): Delete a contact.
- [Get Contact](https://docs.truedy.ai/api-reference/contacts/get-contact.md): Retrieve details about a specific contact.
- [Import Contacts (CSV)](https://docs.truedy.ai/api-reference/contacts/import-contacts-csv.md): Bulk-import contacts from a CSV file.
- [List Contact Folders](https://docs.truedy.ai/api-reference/contacts/list-contact-folders.md): Retrieve all contact folders in your organization. Folders organize contacts for targeted campaigns.
- [List Contacts](https://docs.truedy.ai/api-reference/contacts/list-contacts.md): Retrieve all contacts in your organization.
- [Update Contact](https://docs.truedy.ai/api-reference/contacts/update-contact.md): Update contact information (name, email, custom fields).
- [API Reference](https://docs.truedy.ai/api-reference/introduction.md): Complete API reference for Truedy Public API
- [Create Knowledge Base](https://docs.truedy.ai/api-reference/knowledge-bases/create-knowledge-base.md): Create a new knowledge base from text or file content.
- [Delete Knowledge Base](https://docs.truedy.ai/api-reference/knowledge-bases/delete-knowledge-base.md): Delete a knowledge base. Knowledge base must not be in use by any agent.
- [Get Knowledge Base](https://docs.truedy.ai/api-reference/knowledge-bases/get-knowledge-base.md): Retrieve details about a specific knowledge base.
- [List Knowledge Bases](https://docs.truedy.ai/api-reference/knowledge-bases/list-knowledge-bases.md): Retrieve all knowledge bases in your organization.
- [Update Knowledge Base](https://docs.truedy.ai/api-reference/knowledge-bases/update-knowledge-base.md): Update knowledge base metadata (name, description).
- [Assign Phone Number](https://docs.truedy.ai/api-reference/telephony/assign-phone-number.md): Assign a phone number to an agent for inbound or outbound calls.
- [Get Agent Inbound Webhook URL](https://docs.truedy.ai/api-reference/telephony/get-agent-inbound-webhook-url.md): Get the inbound webhook URL for an agent. Configure this URL in your telephony provider (Twilio, Vonage, etc.) to route inbound calls to this agent.
- [List Agent Phone Numbers](https://docs.truedy.ai/api-reference/telephony/list-agent-phone-numbers.md): Retrieve all phone numbers currently assigned to a specific agent.
- [List Phone Numbers](https://docs.truedy.ai/api-reference/telephony/list-phone-numbers.md): Retrieve all phone numbers in your organization.
- [Unassign Phone Number](https://docs.truedy.ai/api-reference/telephony/unassign-phone-number.md): Remove assignment of a phone number from an agent.
- [Create Tool](https://docs.truedy.ai/api-reference/tools/create-tool.md): Create a new tool that agents can use during calls.
- [Delete Tool](https://docs.truedy.ai/api-reference/tools/delete-tool.md): Delete a tool. Tool must not be in use by any agent.
- [Get Tool](https://docs.truedy.ai/api-reference/tools/get-tool.md): Retrieve details about a specific tool.
- [List Tools](https://docs.truedy.ai/api-reference/tools/list-tools.md): Retrieve all tools available in your organization.
- [Update Tool](https://docs.truedy.ai/api-reference/tools/update-tool.md): Update tool configuration and definition.
- [Clone Voice](https://docs.truedy.ai/api-reference/voices/clone-voice.md): Create a custom voice clone from your audio files. Requires base64-encoded audio samples.
- [Get Voice](https://docs.truedy.ai/api-reference/voices/get-voice.md): Retrieve details about a specific voice.
- [List Voices](https://docs.truedy.ai/api-reference/voices/list-voices.md): Retrieve all available voices for use with agents.
- [Authentication](https://docs.truedy.ai/authentication.md): Authenticate to the Truedy API with API keys or JWT
- [Changelog](https://docs.truedy.ai/changelog.md): API and documentation changes
- [Agents & Calls Overview](https://docs.truedy.ai/guides/agents-calls-overview.md): Understand how agents, calls, campaigns, contacts, and numbers fit together in Truedy
- [Available Webhooks](https://docs.truedy.ai/guides/available-webhooks.md): Event catalogue and payload shapes for Truedy webhooks
- [Batch Calls & Campaigns Overview](https://docs.truedy.ai/guides/batch-calls-and-campaigns-overview.md): Learn how Truedy batch calls and campaigns work end to end
- [Built-in Tools](https://docs.truedy.ai/guides/built-in-tools.md): Pre-built integrations you can enable for your agents without writing any code
- [Buying a Phone Number](https://docs.truedy.ai/guides/buying-phone-numbers.md): Purchase Truedy-managed phone numbers for outbound and inbound calling
- [Call Management](https://docs.truedy.ai/guides/call-management.md): Monitor active calls, retrieve transcripts, and access recordings
- [Calls Overview](https://docs.truedy.ai/guides/calls-overview.md): Understand how individual calls work in Truedy — statuses, directions, and the call lifecycle
- [Campaign Analytics & Reporting](https://docs.truedy.ai/guides/campaign-analytics-and-reporting.md): How to interpret campaign performance and drill into outcomes
- [Creating an Agent](https://docs.truedy.ai/guides/creating-an-agent.md): Learn how to create and configure AI voice agents
- [Creating Your First Campaign](https://docs.truedy.ai/guides/creating-your-first-campaign.md): Step-by-step to launch a batch calling campaign
- [Custom Tools](https://docs.truedy.ai/guides/custom-tools.md): Build your own tools — connect your agents to any API or internal system
- [Embed a Voice Widget on Your Website](https://docs.truedy.ai/guides/embed-widget.md): Add a live AI voice call button to any website in minutes using the Truedy pre-built widget — no backend required.
- [Error Handling](https://docs.truedy.ai/guides/error-handling.md): How the Truedy API reports errors and how to handle them
- [How Truedy Works](https://docs.truedy.ai/guides/how-truedy-works.md): High-level overview of Truedy, Ultravox, telephony providers, and your app
- [Idempotency](https://docs.truedy.ai/guides/idempotency.md): Safely retry create requests with X-Idempotency-Key
- [Importing Phone Numbers](https://docs.truedy.ai/guides/importing-phone-numbers.md): Use your existing Twilio or Telnyx numbers with Truedy agents
- [Knowledge Bases](https://docs.truedy.ai/guides/knowledge-bases-overview.md): Give your agents accurate, up-to-date answers by connecting them to your own documents
- [Making Outbound Calls](https://docs.truedy.ai/guides/making-outbound-calls.md): Use the API to place a single outbound phone call from one of your agents
- [Managing Knowledge Base Sources](https://docs.truedy.ai/guides/managing-kb-sources.md): Add, update, and remove the documents that power your agent's knowledge
- [Pause, Resume, and Edit Campaigns](https://docs.truedy.ai/guides/pause-resume-edit-campaigns.md): Clear semantics for stopping scheduled calls and resuming them safely
- [Post-call Analysis](https://docs.truedy.ai/guides/post-call-analysis.md): Turn call & campaign webhook events into analytics safely
- [Preparing Contacts](https://docs.truedy.ai/guides/preparing-contacts.md): Build clean contact lists for batch campaigns (E.164, folders, CSV formats)
- [Prompting & Agent Design Basics](https://docs.truedy.ai/guides/prompting-and-agent-design-basics.md): Learn how to design Truedy agents that behave reliably in real calls
- [Quickstart: Web Call](https://docs.truedy.ai/guides/quickstart-web-call.md): Add a live AI voice button to your website in under 15 minutes
- [Rate Limits](https://docs.truedy.ai/guides/rate-limits.md): Understanding rate limits and usage tracking
- [Scaling & Concurrency](https://docs.truedy.ai/guides/scaling-and-concurrency.md): How to plan reliable volume with max concurrency, daily caps, rate limits, and safe retries
- [Scheduling & Delivery Logic](https://docs.truedy.ai/guides/scheduling-and-delivery-logic.md): How Truedy turns a campaign schedule into individual scheduled calls
- [Securing Webhooks](https://docs.truedy.ai/guides/securing-webhooks.md): Verify Truedy webhook signatures and prevent replay attacks in Node.js, Python, and Go
- [Setting Up Inbound Calls](https://docs.truedy.ai/guides/setting-up-inbound-calls.md): Route incoming calls to your agents automatically
- [Telephony Overview](https://docs.truedy.ai/guides/telephony-overview.md): Phone numbers in Truedy — types, providers, and how they connect to your agents
- [Tools Overview](https://docs.truedy.ai/guides/tools-overview.md): Give your agents the ability to take actions during a call — look up data, book appointments, and more
- [Webhook Error Handling & Retries](https://docs.truedy.ai/guides/webhook-error-handling-and-retries.md): Build idempotent receivers that handle duplicates, failures, and retries correctly
- [Webhooks Overview](https://docs.truedy.ai/guides/webhooks-overview.md): Understand how Truedy webhooks work, when to use them, and how to set one up in 5 minutes
- [Building a Custom Voice Widget](https://docs.truedy.ai/guides/webrtc-custom-widget.md): Use the Truedy WebRTC API to embed a live AI voice call button on any website
- [Your First Hour with Truedy](https://docs.truedy.ai/guides/your-first-hour-with-truedy.md): Follow this guided path to go from zero to a live outbound campaign
- [Introduction](https://docs.truedy.ai/introduction.md): Welcome to the Truedy API documentation
- [Quickstart](https://docs.truedy.ai/quickstart.md): Get started with the Truedy API in 5 minutes
- [cURL](https://docs.truedy.ai/sdks/curl.md): Using the Truedy API with cURL
- [JavaScript SDK](https://docs.truedy.ai/sdks/javascript.md): Official JavaScript/TypeScript SDK for Truedy
- [Python SDK](https://docs.truedy.ai/sdks/python.md): Python SDK for the Truedy API
- [API Versioning](https://docs.truedy.ai/versioning.md): How the Truedy API is versioned and what to expect when we make changes

## OpenAPI Specs

- [openapi](https://docs.truedy.ai/openapi.json)

## Optional

- [Documentation](https://docs.truedy.ai)
- [API Reference](https://docs.truedy.ai/api-reference)
- [Support](mailto:support@truedy.ai)