# Aigently API

> Place calls, start chats and read conversations from your own server. Authenticate with an organization API key: `ag_test_…` for test data that rings nobody, `ag_live_…` for real calls. Errors are RFC 9457 problem documents with a stable `code`.

Every page below is Markdown. The API's full description is the OpenAPI file, https://developers.aigently.ai/openapi.v1.json.

## Get started

- [Aigently API](https://developers.aigently.ai/index.md): Place calls, start chats and read every conversation from your own server.
- [Quickstart](https://developers.aigently.ai/quickstart.md): A test call that rings nobody, its transcript and analysis, then its webhooks and a test inbound call on your own machine.
- [Going live](https://developers.aigently.ai/going-live.md): What changes when the same code runs with a live key.
- [The command line](https://developers.aigently.ai/cli.md): Every API operation from a terminal, an agent's fields as types, test events on your own machine, and MCP over standard input.

## Guides

- [Outbound calls](https://developers.aigently.ai/guides/outbound-calls.md): Place a call with an agent, follow it, end it, and know what each ending means.
- [Variables](https://developers.aigently.ai/guides/variables.md): How an agent's fields are declared, filled, checked, and kept from rewriting the agent.
- [Inbound calls](https://developers.aigently.ai/guides/inbound-calls.md): Tell an agent who is calling — your server is asked while the phone is answered, and the values reach the agent before its first reply.
- [Chat and streaming](https://developers.aigently.ai/guides/chat.md): Hold a conversation with an agent from your own app — one message at a time, as a whole reply or as it is written.
- [Reading and syncing conversations](https://developers.aigently.ai/guides/conversations.md): List, search and read conversations, their transcripts and recordings, keep your own copy up to date, and delete them.
- [Webhooks](https://developers.aigently.ai/guides/webhooks.md): Hear about every conversation as it happens, signed so you know it came from Aigently.
- [The event feed](https://developers.aigently.ai/guides/events.md): Every event of the last 30 days, in order — to catch up on webhooks you missed, or instead of receiving them at all.
- [Test mode](https://developers.aigently.ai/guides/test-mode.md): Build and test an integration without a phone number, a carrier or credit — and without ever ringing anybody.
- [Rate limits](https://developers.aigently.ai/guides/rate-limits.md): How fast a key may call the API, the headers that say how much is left, and what to do at a limit.
- [Safe retries](https://developers.aigently.ai/guides/idempotency.md): Send a request again after a timeout without calling anybody twice.
- [API keys](https://developers.aigently.ai/guides/keys.md): Organization keys, test and live, what each may do and reach — and the older per-agent chat keys.
- [Signing visitors in the widget](https://developers.aigently.ai/guides/widget-identity.md): Hand the chat widget what your server knows about a signed-in visitor, signed so the agent can rely on it.
- [Credit and billing](https://developers.aigently.ai/guides/billing.md): Read your organization's credit balance, every charge and every credit added, and what each conversation cost.
- [Phone numbers](https://developers.aigently.ai/guides/phone-numbers.md): List your organization's phone numbers, and choose the agent each one belongs to.
- [Campaigns](https://developers.aigently.ai/guides/campaigns.md): Call a list of people at a pace you set, only in calling hours, and hear how each call went.
- [Contacts](https://developers.aigently.ai/guides/contacts.md): Keep each project's phonebook in step with your own systems, by number.
- [Knowledge](https://developers.aigently.ai/guides/knowledge.md): Keep what your agents answer from in step with your own documents.
- [Browser calls](https://developers.aigently.ai/guides/browser-calls.md): Put a voice call with your agent in your own web page, and a chat beside it.
- [AI assistants (MCP)](https://developers.aigently.ai/guides/mcp.md): Let Claude, or any assistant that speaks MCP, read your conversations — and, if you allow it, act.
- [Audit log](https://developers.aigently.ai/guides/audit-log.md): Everything people and keys did in your organization, read by your security system.
- [Agents as code](https://developers.aigently.ai/guides/agents-as-code.md): Keep your agents in a repository, and deploy them the way you deploy everything else.
- [Tools and credentials](https://developers.aigently.ai/guides/tools.md): Manage the APIs your agents call mid-conversation, and the credentials they send, from your own pipeline.
- [Evaluations in your pipeline](https://developers.aigently.ai/guides/evaluations.md): Rehearse an agent's saved conversations on every change, and fail the build when one no longer passes.
- [Terraform](https://developers.aigently.ai/guides/terraform.md): Keep agents, their tools and credentials, their evaluations and your webhook receivers in Terraform.
- [Mobile apps](https://developers.aigently.ai/guides/mobile.md): Put a voice call with your agent, and a chat beside it, in your own iOS or Android app.
- [Live calls](https://developers.aigently.ai/guides/live-calls.md): Follow a call's transcript while it happens, and have the agent say something, take a note, or transfer the caller.
- [WhatsApp conversations](https://developers.aigently.ai/guides/whatsapp.md): Start a WhatsApp conversation with an approved template, and let your agent take it from the first reply.

## API reference

- [API reference](https://developers.aigently.ai/reference.md): Every operation of the Aigently API.
- [Describe this API key](https://developers.aigently.ai/reference/getMe.md): GET /v1/me
- [List projects](https://developers.aigently.ai/reference/listProjects.md): GET /v1/projects
- [List agents](https://developers.aigently.ai/reference/listAgents.md): GET /v1/agents
- [Create an agent](https://developers.aigently.ai/reference/createAgent.md): POST /v1/agents
- [Get an agent](https://developers.aigently.ai/reference/getAgent.md): GET /v1/agents/{agent_id}
- [Delete an agent](https://developers.aigently.ai/reference/deleteAgent.md): DELETE /v1/agents/{agent_id}
- [Get an agent's definition](https://developers.aigently.ai/reference/getAgentDefinition.md): GET /v1/agents/{agent_id}/definition
- [Replace an agent's definition](https://developers.aigently.ai/reference/replaceAgentDefinition.md): PUT /v1/agents/{agent_id}/definition
- [Publish an agent](https://developers.aigently.ai/reference/publishAgent.md): POST /v1/agents/{agent_id}/publish
- [List an agent's versions](https://developers.aigently.ai/reference/listAgentVersions.md): GET /v1/agents/{agent_id}/versions
- [Get a published version's definition](https://developers.aigently.ai/reference/getAgentVersionDefinition.md): GET /v1/agents/{agent_id}/versions/{version}/definition
- [Run an agent's evaluations](https://developers.aigently.ai/reference/runEvaluations.md): POST /v1/agents/{agent_id}/evaluation-runs
- [List an agent's evaluations](https://developers.aigently.ai/reference/listEvaluations.md): GET /v1/agents/{agent_id}/evaluations
- [Add an evaluation](https://developers.aigently.ai/reference/createEvaluation.md): POST /v1/agents/{agent_id}/evaluations
- [Delete an evaluation](https://developers.aigently.ai/reference/deleteEvaluation.md): DELETE /v1/agents/{agent_id}/evaluations/{evaluation_id}
- [Get an evaluation run](https://developers.aigently.ai/reference/getEvaluationRun.md): GET /v1/evaluation-runs/{run_id}
- [List phone numbers](https://developers.aigently.ai/reference/listPhoneNumbers.md): GET /v1/phone-numbers
- [Point a phone number at an agent](https://developers.aigently.ai/reference/updatePhoneNumber.md): PATCH /v1/phone-numbers/{phone_number_id}
- [Place a call](https://developers.aigently.ai/reference/createCall.md): POST /v1/calls
- [End a conversation](https://developers.aigently.ai/reference/endConversation.md): POST /v1/conversations/{conversation_id}/end
- [List scheduled calls](https://developers.aigently.ai/reference/listScheduledCalls.md): GET /v1/scheduled-calls
- [Schedule a call](https://developers.aigently.ai/reference/createScheduledCall.md): POST /v1/scheduled-calls
- [Get a scheduled call](https://developers.aigently.ai/reference/getScheduledCall.md): GET /v1/scheduled-calls/{scheduled_call_id}
- [Cancel a scheduled call](https://developers.aigently.ai/reference/cancelScheduledCall.md): DELETE /v1/scheduled-calls/{scheduled_call_id}
- [List campaigns](https://developers.aigently.ai/reference/listCampaigns.md): GET /v1/campaigns
- [Create a campaign](https://developers.aigently.ai/reference/createCampaign.md): POST /v1/campaigns
- [Get a campaign](https://developers.aigently.ai/reference/getCampaign.md): GET /v1/campaigns/{campaign_id}
- [Cancel a campaign](https://developers.aigently.ai/reference/cancelCampaign.md): POST /v1/campaigns/{campaign_id}/cancel
- [List a campaign's contacts](https://developers.aigently.ai/reference/listCampaignContacts.md): GET /v1/campaigns/{campaign_id}/contacts
- [Add contacts to a campaign](https://developers.aigently.ai/reference/addCampaignContacts.md): POST /v1/campaigns/{campaign_id}/contacts
- [Pause a campaign](https://developers.aigently.ai/reference/pauseCampaign.md): POST /v1/campaigns/{campaign_id}/pause
- [Resume a campaign](https://developers.aigently.ai/reference/resumeCampaign.md): POST /v1/campaigns/{campaign_id}/resume
- [Start a campaign](https://developers.aigently.ai/reference/startCampaign.md): POST /v1/campaigns/{campaign_id}/start
- [List contacts](https://developers.aigently.ai/reference/listContacts.md): GET /v1/contacts
- [Add a contact](https://developers.aigently.ai/reference/createContact.md): POST /v1/contacts
- [Import contacts](https://developers.aigently.ai/reference/importContacts.md): POST /v1/contacts/import
- [Get a contact](https://developers.aigently.ai/reference/getContact.md): GET /v1/contacts/{contact_id}
- [Change a contact](https://developers.aigently.ai/reference/updateContact.md): PATCH /v1/contacts/{contact_id}
- [Delete a contact](https://developers.aigently.ai/reference/deleteContact.md): DELETE /v1/contacts/{contact_id}
- [List knowledge bases](https://developers.aigently.ai/reference/listKnowledgeBases.md): GET /v1/knowledge-bases
- [List the websites a knowledge base reads](https://developers.aigently.ai/reference/listKnowledgeCrawls.md): GET /v1/knowledge-bases/{knowledge_base_id}/crawls
- [Read a website again](https://developers.aigently.ai/reference/refreshKnowledgeCrawl.md): POST /v1/knowledge-bases/{knowledge_base_id}/crawls/{crawl_id}/refresh
- [List a knowledge base's sources](https://developers.aigently.ai/reference/listKnowledgeDocuments.md): GET /v1/knowledge-bases/{knowledge_base_id}/documents
- [Add a file to a knowledge base](https://developers.aigently.ai/reference/uploadKnowledgeDocument.md): POST /v1/knowledge-bases/{knowledge_base_id}/documents
- [Get a source](https://developers.aigently.ai/reference/getKnowledgeDocument.md): GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
- [Replace a file](https://developers.aigently.ai/reference/replaceKnowledgeDocument.md): PUT /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
- [Delete a source](https://developers.aigently.ai/reference/deleteKnowledgeDocument.md): DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}
- [List MCP servers](https://developers.aigently.ai/reference/listMcpServers.md): GET /v1/mcp-servers
- [Add an MCP server](https://developers.aigently.ai/reference/createMcpServer.md): POST /v1/mcp-servers
- [Get an MCP server](https://developers.aigently.ai/reference/getMcpServer.md): GET /v1/mcp-servers/{server_id}
- [Change an MCP server](https://developers.aigently.ai/reference/updateMcpServer.md): PATCH /v1/mcp-servers/{server_id}
- [Delete an MCP server](https://developers.aigently.ai/reference/deleteMcpServer.md): DELETE /v1/mcp-servers/{server_id}
- [List tools](https://developers.aigently.ai/reference/listTools.md): GET /v1/tools
- [Create a tool](https://developers.aigently.ai/reference/createTool.md): POST /v1/tools
- [Get a tool](https://developers.aigently.ai/reference/getTool.md): GET /v1/tools/{tool_id}
- [Change a tool](https://developers.aigently.ai/reference/updateTool.md): PATCH /v1/tools/{tool_id}
- [Delete a tool](https://developers.aigently.ai/reference/deleteTool.md): DELETE /v1/tools/{tool_id}
- [List tool credentials](https://developers.aigently.ai/reference/listVaultSecrets.md): GET /v1/vault/secrets
- [Add a tool credential](https://developers.aigently.ai/reference/createVaultSecret.md): POST /v1/vault/secrets
- [Get a tool credential](https://developers.aigently.ai/reference/getVaultSecret.md): GET /v1/vault/secrets/{secret_id}
- [Change a tool credential](https://developers.aigently.ai/reference/updateVaultSecret.md): PATCH /v1/vault/secrets/{secret_id}
- [Delete a tool credential](https://developers.aigently.ai/reference/deleteVaultSecret.md): DELETE /v1/vault/secrets/{secret_id}
- [List the do-not-call list](https://developers.aigently.ai/reference/listDoNotCall.md): GET /v1/do-not-call
- [Add a number to the do-not-call list](https://developers.aigently.ai/reference/addDoNotCall.md): POST /v1/do-not-call
- [Take a number off the do-not-call list](https://developers.aigently.ai/reference/removeDoNotCall.md): DELETE /v1/do-not-call/{number}
- [Upload a picture](https://developers.aigently.ai/reference/uploadAttachment.md): POST /v1/attachments
- [Start a chat](https://developers.aigently.ai/reference/createChat.md): POST /v1/chats
- [Send a message](https://developers.aigently.ai/reference/sendMessage.md): POST /v1/conversations/{conversation_id}/messages
- [Start a WhatsApp conversation](https://developers.aigently.ai/reference/startWhatsappConversation.md): POST /v1/whatsapp/conversations
- [List WhatsApp numbers](https://developers.aigently.ai/reference/listWhatsappSenders.md): GET /v1/whatsapp/senders
- [List a WhatsApp number's templates](https://developers.aigently.ai/reference/listWhatsappTemplates.md): GET /v1/whatsapp/senders/{sender_id}/templates
- [Start a browser call](https://developers.aigently.ai/reference/createWebCall.md): POST /v1/web-calls
- [List conversations](https://developers.aigently.ai/reference/listConversations.md): GET /v1/conversations
- [List deleted conversations](https://developers.aigently.ai/reference/listDeletedConversations.md): GET /v1/conversations/deleted
- [Get a conversation](https://developers.aigently.ai/reference/getConversation.md): GET /v1/conversations/{conversation_id}
- [Delete a conversation](https://developers.aigently.ai/reference/deleteConversation.md): DELETE /v1/conversations/{conversation_id}
- [Analyse a conversation again](https://developers.aigently.ai/reference/analyzeConversation.md): POST /v1/conversations/{conversation_id}/analysis
- [Get a link to a conversation's recording](https://developers.aigently.ai/reference/getRecording.md): GET /v1/conversations/{conversation_id}/recording
- [Get a conversation's transcript](https://developers.aigently.ai/reference/getTranscript.md): GET /v1/conversations/{conversation_id}/transcript
- [Get a command](https://developers.aigently.ai/reference/getConversationCommand.md): GET /v1/conversations/{conversation_id}/commands/{command_id}
- [Follow a call's transcript live](https://developers.aigently.ai/reference/getLiveTranscript.md): GET /v1/conversations/{conversation_id}/live
- [Give the agent a note](https://developers.aigently.ai/reference/addConversationNote.md): POST /v1/conversations/{conversation_id}/notes
- [Have the agent say something](https://developers.aigently.ai/reference/sayInConversation.md): POST /v1/conversations/{conversation_id}/say
- [Transfer a call](https://developers.aigently.ai/reference/transferConversation.md): POST /v1/conversations/{conversation_id}/transfer
- [List events](https://developers.aigently.ai/reference/listEvents.md): GET /v1/events
- [List webhook receivers](https://developers.aigently.ai/reference/listWebhookReceivers.md): GET /v1/webhooks
- [Create a webhook receiver](https://developers.aigently.ai/reference/createWebhookReceiver.md): POST /v1/webhooks
- [Get a webhook receiver](https://developers.aigently.ai/reference/getWebhookReceiver.md): GET /v1/webhooks/{receiver_id}
- [Change a webhook receiver](https://developers.aigently.ai/reference/updateWebhookReceiver.md): PATCH /v1/webhooks/{receiver_id}
- [Delete a webhook receiver](https://developers.aigently.ai/reference/deleteWebhookReceiver.md): DELETE /v1/webhooks/{receiver_id}
- [List a receiver's deliveries](https://developers.aigently.ai/reference/listWebhookDeliveries.md): GET /v1/webhooks/{receiver_id}/deliveries
- [Send a delivery again](https://developers.aigently.ai/reference/resendWebhookDelivery.md): POST /v1/webhooks/{receiver_id}/deliveries/{delivery_id}/resend
- [Change a webhook receiver's secret](https://developers.aigently.ai/reference/rotateWebhookSecret.md): POST /v1/webhooks/{receiver_id}/rotate-secret
- [Send a test event](https://developers.aigently.ai/reference/testWebhookReceiver.md): POST /v1/webhooks/{receiver_id}/test
- [Get the credit balance](https://developers.aigently.ai/reference/getCreditBalance.md): GET /v1/billing/balance
- [List credit transactions](https://developers.aigently.ai/reference/listCreditTransactions.md): GET /v1/billing/transactions
- [List audit events](https://developers.aigently.ai/reference/listAuditEvents.md): GET /v1/audit-events
- [Make a test call to an agent](https://developers.aigently.ai/reference/createTestInboundCall.md): POST /v1/test/inbound-calls
- [Objects](https://developers.aigently.ai/reference/objects.md): What the API answers with.
- [Agent](https://developers.aigently.ai/reference/objects/Agent.md): The Agent object.
- [AgentDefinition](https://developers.aigently.ai/reference/objects/AgentDefinition.md): An agent as a document: everything about how it behaves, and everything outside it by name
- [AgentDeleted](https://developers.aigently.ai/reference/objects/AgentDeleted.md): The AgentDeleted object.
- [AgentDetail](https://developers.aigently.ai/reference/objects/AgentDetail.md): The AgentDetail object.
- [AgentDirection](https://developers.aigently.ai/reference/objects/AgentDirection.md): The AgentDirection object.
- [AgentKind](https://developers.aigently.ai/reference/objects/AgentKind.md): The AgentKind object.
- [AgentList](https://developers.aigently.ai/reference/objects/AgentList.md): The AgentList object.
- [AgentPublishRequest](https://developers.aigently.ai/reference/objects/AgentPublishRequest.md): The AgentPublishRequest object.
- [AgentStatus](https://developers.aigently.ai/reference/objects/AgentStatus.md): The AgentStatus object.
- [AgentVersionList](https://developers.aigently.ai/reference/objects/AgentVersionList.md): The AgentVersionList object.
- [AgentVersionObject](https://developers.aigently.ai/reference/objects/AgentVersionObject.md): One published version of an agent: what pinning a conversation to it gets.
- [AgentWritten](https://developers.aigently.ai/reference/objects/AgentWritten.md): The AgentWritten object.
- [Analysis](https://developers.aigently.ai/reference/objects/Analysis.md): The Analysis object.
- [Attachment](https://developers.aigently.ai/reference/objects/Attachment.md): The Attachment object.
- [AuditActor](https://developers.aigently.ai/reference/objects/AuditActor.md): The AuditActor object.
- [AuditEvent](https://developers.aigently.ai/reference/objects/AuditEvent.md): One thing somebody did in the organization: in the console, or with an API key.
- [AuditEventList](https://developers.aigently.ai/reference/objects/AuditEventList.md): The AuditEventList object.
- [CallWindow](https://developers.aigently.ai/reference/objects/CallWindow.md): The hours a call may start in, read in one time zone (`services/calling_hours`).
- [Campaign](https://developers.aigently.ai/reference/objects/Campaign.md): The Campaign object.
- [CampaignCallbacks](https://developers.aigently.ai/reference/objects/CampaignCallbacks.md): The CampaignCallbacks object.
- [CampaignCallbacksObject](https://developers.aigently.ai/reference/objects/CampaignCallbacksObject.md): The CampaignCallbacksObject object.
- [CampaignCallingHours](https://developers.aigently.ai/reference/objects/CampaignCallingHours.md): The CampaignCallingHours object.
- [CampaignCallingHoursObject](https://developers.aigently.ai/reference/objects/CampaignCallingHoursObject.md): The CampaignCallingHoursObject object.
- [CampaignContact](https://developers.aigently.ai/reference/objects/CampaignContact.md): The CampaignContact object.
- [CampaignContactCreate](https://developers.aigently.ai/reference/objects/CampaignContactCreate.md): The CampaignContactCreate object.
- [CampaignContactList](https://developers.aigently.ai/reference/objects/CampaignContactList.md): The CampaignContactList object.
- [CampaignContactStatus](https://developers.aigently.ai/reference/objects/CampaignContactStatus.md): The CampaignContactStatus object.
- [CampaignContactsAdded](https://developers.aigently.ai/reference/objects/CampaignContactsAdded.md): The CampaignContactsAdded object.
- [CampaignCounts](https://developers.aigently.ai/reference/objects/CampaignCounts.md): The CampaignCounts object.
- [CampaignList](https://developers.aigently.ai/reference/objects/CampaignList.md): The CampaignList object.
- [CampaignPacing](https://developers.aigently.ai/reference/objects/CampaignPacing.md): The CampaignPacing object.
- [CampaignPacingObject](https://developers.aigently.ai/reference/objects/CampaignPacingObject.md): The CampaignPacingObject object.
- [CampaignResume](https://developers.aigently.ai/reference/objects/CampaignResume.md): The CampaignResume object.
- [CampaignStatus](https://developers.aigently.ai/reference/objects/CampaignStatus.md): The CampaignStatus object.
- [CampaignVoicemail](https://developers.aigently.ai/reference/objects/CampaignVoicemail.md): The CampaignVoicemail object.
- [CampaignVoicemailObject](https://developers.aigently.ai/reference/objects/CampaignVoicemailObject.md): The CampaignVoicemailObject object.
- [Capabilities](https://developers.aigently.ai/reference/objects/Capabilities.md): What this deployment of Aigently runs — a company's own copy may switch parts off.
- [Channel](https://developers.aigently.ai/reference/objects/Channel.md): The Channel object.
- [ChatTurn](https://developers.aigently.ai/reference/objects/ChatTurn.md): One exchange: what the agent said back, and where the conversation stands after it.
- [Contact](https://developers.aigently.ai/reference/objects/Contact.md): The Contact object.
- [ContactDeleted](https://developers.aigently.ai/reference/objects/ContactDeleted.md): The ContactDeleted object.
- [ContactFields](https://developers.aigently.ai/reference/objects/ContactFields.md): The ContactFields object.
- [ContactImported](https://developers.aigently.ai/reference/objects/ContactImported.md): The ContactImported object.
- [ContactList](https://developers.aigently.ai/reference/objects/ContactList.md): The ContactList object.
- [Context](https://developers.aigently.ai/reference/objects/Context.md): What the context lookup made of an inbound call (§9.2).
- [ContextProblem](https://developers.aigently.ai/reference/objects/ContextProblem.md): The ContextProblem object.
- [Conversation](https://developers.aigently.ai/reference/objects/Conversation.md): `docs/plans/public-api-and-sdks.md` §6.4 — built by `services/conversation_object`.
- [ConversationCommandObject](https://developers.aigently.ai/reference/objects/ConversationCommandObject.md): Something a live call was asked to do.
- [ConversationList](https://developers.aigently.ai/reference/objects/ConversationList.md): The ConversationList object.
- [ConversationListItem](https://developers.aigently.ai/reference/objects/ConversationListItem.md): A conversation as the list returns it
- [ConversationMode](https://developers.aigently.ai/reference/objects/ConversationMode.md): The ConversationMode object.
- [ConversationStatus](https://developers.aigently.ai/reference/objects/ConversationStatus.md): The ConversationStatus object.
- [ConversationWithTranscript](https://developers.aigently.ai/reference/objects/ConversationWithTranscript.md): The ConversationWithTranscript object.
- [Cost](https://developers.aigently.ai/reference/objects/Cost.md): The Cost object.
- [CreditBalance](https://developers.aigently.ai/reference/objects/CreditBalance.md): The CreditBalance object.
- [CreditEntryKind](https://developers.aigently.ai/reference/objects/CreditEntryKind.md): The CreditEntryKind object.
- [CreditTransaction](https://developers.aigently.ai/reference/objects/CreditTransaction.md): The CreditTransaction object.
- [CreditTransactionList](https://developers.aigently.ai/reference/objects/CreditTransactionList.md): The CreditTransactionList object.
- [Criterion](https://developers.aigently.ai/reference/objects/Criterion.md): The Criterion object.
- [Deleted](https://developers.aigently.ai/reference/objects/Deleted.md): The Deleted object.
- [DeletedConversation](https://developers.aigently.ai/reference/objects/DeletedConversation.md): The DeletedConversation object.
- [DeletedConversationList](https://developers.aigently.ai/reference/objects/DeletedConversationList.md): The DeletedConversationList object.
- [Direction](https://developers.aigently.ai/reference/objects/Direction.md): The Direction object.
- [Disposition](https://developers.aigently.ai/reference/objects/Disposition.md): The Disposition object.
- [DoNotCallEntry](https://developers.aigently.ai/reference/objects/DoNotCallEntry.md): The DoNotCallEntry object.
- [DoNotCallList](https://developers.aigently.ai/reference/objects/DoNotCallList.md): The DoNotCallList object.
- [DoNotCallRemoved](https://developers.aigently.ai/reference/objects/DoNotCallRemoved.md): The DoNotCallRemoved object.
- [EndedBy](https://developers.aigently.ai/reference/objects/EndedBy.md): The EndedBy object.
- [EvaluationExpectation](https://developers.aigently.ai/reference/objects/EvaluationExpectation.md): The EvaluationExpectation object.
- [EvaluationExpectationCreate](https://developers.aigently.ai/reference/objects/EvaluationExpectationCreate.md): The EvaluationExpectationCreate object.
- [EvaluationLatest](https://developers.aigently.ai/reference/objects/EvaluationLatest.md): The EvaluationLatest object.
- [EvaluationList](https://developers.aigently.ai/reference/objects/EvaluationList.md): The EvaluationList object.
- [EvaluationObject](https://developers.aigently.ai/reference/objects/EvaluationObject.md): A saved conversation: what a caller says, and what must be true of the agent's replies.
- [EvaluationResult](https://developers.aigently.ai/reference/objects/EvaluationResult.md): The EvaluationResult object.
- [EvaluationRunObject](https://developers.aigently.ai/reference/objects/EvaluationRunObject.md): One rehearsal of every saved conversation an agent has.
- [EvaluationTurn](https://developers.aigently.ai/reference/objects/EvaluationTurn.md): The EvaluationTurn object.
- [EvaluationVerdict](https://developers.aigently.ai/reference/objects/EvaluationVerdict.md): The EvaluationVerdict object.
- [Event](https://developers.aigently.ai/reference/objects/Event.md): One event, as a webhook receiver was sent it — under the same id.
- [EventList](https://developers.aigently.ai/reference/objects/EventList.md): The EventList object.
- [Handoff](https://developers.aigently.ai/reference/objects/Handoff.md): The Handoff object.
- [Include](https://developers.aigently.ai/reference/objects/Include.md): The Include object.
- [KnowledgeBaseList](https://developers.aigently.ai/reference/objects/KnowledgeBaseList.md): The KnowledgeBaseList object.
- [KnowledgeBaseObject](https://developers.aigently.ai/reference/objects/KnowledgeBaseObject.md): The KnowledgeBaseObject object.
- [KnowledgeCrawl](https://developers.aigently.ai/reference/objects/KnowledgeCrawl.md): The KnowledgeCrawl object.
- [KnowledgeCrawlList](https://developers.aigently.ai/reference/objects/KnowledgeCrawlList.md): The KnowledgeCrawlList object.
- [KnowledgeDocument](https://developers.aigently.ai/reference/objects/KnowledgeDocument.md): The KnowledgeDocument object.
- [KnowledgeDocumentDeleted](https://developers.aigently.ai/reference/objects/KnowledgeDocumentDeleted.md): The KnowledgeDocumentDeleted object.
- [KnowledgeDocumentList](https://developers.aigently.ai/reference/objects/KnowledgeDocumentList.md): The KnowledgeDocumentList object.
- [KnowledgeDocumentStatus](https://developers.aigently.ai/reference/objects/KnowledgeDocumentStatus.md): The KnowledgeDocumentStatus object.
- [Language](https://developers.aigently.ai/reference/objects/Language.md): The Language object.
- [Languages](https://developers.aigently.ai/reference/objects/Languages.md): The Languages object.
- [Limits](https://developers.aigently.ai/reference/objects/Limits.md): Every ceiling that applies to this key, and how much of the calls one is in use now.
- [LiveLineObject](https://developers.aigently.ai/reference/objects/LiveLineObject.md): One line of a call, as it was said.
- [LiveTranscript](https://developers.aigently.ai/reference/objects/LiveTranscript.md): What was said on a call since `after`, as it is said.
- [McpServerList](https://developers.aigently.ai/reference/objects/McpServerList.md): The McpServerList object.
- [McpServerObject](https://developers.aigently.ai/reference/objects/McpServerObject.md): One remote MCP server whose tools an agent can be given.
- [Me](https://developers.aigently.ai/reference/objects/Me.md): The Me object.
- [Order](https://developers.aigently.ai/reference/objects/Order.md): The Order object.
- [OrganizationRef](https://developers.aigently.ai/reference/objects/OrganizationRef.md): The OrganizationRef object.
- [Outcome](https://developers.aigently.ai/reference/objects/Outcome.md): The Outcome object.
- [PhoneNumber](https://developers.aigently.ai/reference/objects/PhoneNumber.md): The PhoneNumber object.
- [PhoneNumberList](https://developers.aigently.ai/reference/objects/PhoneNumberList.md): The PhoneNumberList object.
- [Problem](https://developers.aigently.ai/reference/objects/Problem.md): RFC 9457 problem details — what every `/v1` error answers with.
- [Project](https://developers.aigently.ai/reference/objects/Project.md): The Project object.
- [ProjectList](https://developers.aigently.ai/reference/objects/ProjectList.md): The ProjectList object.
- [Reach](https://developers.aigently.ai/reference/objects/Reach.md): The Reach object.
- [Recording](https://developers.aigently.ai/reference/objects/Recording.md): The Recording object.
- [Removed](https://developers.aigently.ai/reference/objects/Removed.md): The Removed object.
- [ScheduledCall](https://developers.aigently.ai/reference/objects/ScheduledCall.md): The ScheduledCall object.
- [ScheduledCallList](https://developers.aigently.ai/reference/objects/ScheduledCallList.md): The ScheduledCallList object.
- [ScheduledCallStatus](https://developers.aigently.ai/reference/objects/ScheduledCallStatus.md): The ScheduledCallStatus object.
- [TestInboundCall](https://developers.aigently.ai/reference/objects/TestInboundCall.md): The TestInboundCall object.
- [TestLookup](https://developers.aigently.ai/reference/objects/TestLookup.md): What the agent's context lookup made of a test call.
- [ToolList](https://developers.aigently.ai/reference/objects/ToolList.md): The ToolList object.
- [ToolObject](https://developers.aigently.ai/reference/objects/ToolObject.md): One tool: an HTTP request an agent can make mid-conversation, described for its model.
- [Transcript](https://developers.aigently.ai/reference/objects/Transcript.md): The Transcript object.
- [TranscriptEntry](https://developers.aigently.ai/reference/objects/TranscriptEntry.md): The TranscriptEntry object.
- [UnboundReference](https://developers.aigently.ai/reference/objects/UnboundReference.md): The UnboundReference object.
- [VaultSecretList](https://developers.aigently.ai/reference/objects/VaultSecretList.md): The VaultSecretList object.
- [VaultSecretObject](https://developers.aigently.ai/reference/objects/VaultSecretObject.md): A tool credential in the vault
- [WebCall](https://developers.aigently.ai/reference/objects/WebCall.md): The WebCall object.
- [WebhookDelivery](https://developers.aigently.ai/reference/objects/WebhookDelivery.md): The WebhookDelivery object.
- [WebhookDeliveryList](https://developers.aigently.ai/reference/objects/WebhookDeliveryList.md): The WebhookDeliveryList object.
- [WebhookDeliveryStatus](https://developers.aigently.ai/reference/objects/WebhookDeliveryStatus.md): The WebhookDeliveryStatus object.
- [WebhookReceiver](https://developers.aigently.ai/reference/objects/WebhookReceiver.md): The WebhookReceiver object.
- [WebhookReceiverList](https://developers.aigently.ai/reference/objects/WebhookReceiverList.md): The WebhookReceiverList object.
- [WebhookReceiverWithSecret](https://developers.aigently.ai/reference/objects/WebhookReceiverWithSecret.md): The WebhookReceiverWithSecret object.
- [WebhookTest](https://developers.aigently.ai/reference/objects/WebhookTest.md): The WebhookTest object.
- [WhatsappSenderList](https://developers.aigently.ai/reference/objects/WhatsappSenderList.md): The WhatsappSenderList object.
- [WhatsappSenderObject](https://developers.aigently.ai/reference/objects/WhatsappSenderObject.md): A WhatsApp number of the organization's, and the agent that answers it.
- [WhatsappTemplateChoice](https://developers.aigently.ai/reference/objects/WhatsappTemplateChoice.md): The WhatsappTemplateChoice object.
- [WhatsappTemplateList](https://developers.aigently.ai/reference/objects/WhatsappTemplateList.md): The WhatsappTemplateList object.
- [WhatsappTemplateObject](https://developers.aigently.ai/reference/objects/WhatsappTemplateObject.md): A message template Meta has approved for the number's business account.

## Errors

- [Errors](https://developers.aigently.ai/errors.md): Every error code the API answers with, and what to do about it.
- [An Idempotency-Key header is required](https://developers.aigently.ai/errors/idempotency_key_required.md): 400 idempotency_key_required
- [The request is not valid](https://developers.aigently.ai/errors/invalid_request.md): 400 invalid_request
- [The API key was not accepted](https://developers.aigently.ai/errors/authentication_failed.md): 401 authentication_failed
- [There is not enough credit](https://developers.aigently.ai/errors/insufficient_credit.md): 402 insufficient_credit
- [The key does not work from this address](https://developers.aigently.ai/errors/address_not_allowed.md): 403 address_not_allowed
- [A live key was sent from a browser](https://developers.aigently.ai/errors/live_key_in_browser.md): 403 live_key_in_browser
- [Only a live key does this](https://developers.aigently.ai/errors/live_key_required.md): 403 live_key_required
- [The organization is frozen](https://developers.aigently.ai/errors/organization_frozen.md): 403 organization_frozen
- [This key does not have that permission](https://developers.aigently.ai/errors/permission_denied.md): 403 permission_denied
- [Only a test key does this](https://developers.aigently.ai/errors/test_key_required.md): 403 test_key_required
- [Not found](https://developers.aigently.ai/errors/not_found.md): 404 not_found
- [That method is not allowed here](https://developers.aigently.ai/errors/method_not_allowed.md): 405 method_not_allowed
- [The project already has an agent with that name](https://developers.aigently.ai/errors/agent_name_taken.md): 409 agent_name_taken
- [The agent does not answer calls](https://developers.aigently.ai/errors/agent_not_inbound.md): 409 agent_not_inbound
- [The agent does not place calls](https://developers.aigently.ai/errors/agent_not_outbound.md): 409 agent_not_outbound
- [The agent is not ready to publish](https://developers.aigently.ai/errors/agent_not_publishable.md): 409 agent_not_publishable
- [The agent is not published](https://developers.aigently.ai/errors/agent_not_published.md): 409 agent_not_published
- [The agent does not take browser calls](https://developers.aigently.ai/errors/browser_voice_off.md): 409 browser_voice_off
- [The campaign has nobody to call](https://developers.aigently.ai/errors/campaign_empty.md): 409 campaign_empty
- [The campaign has finished](https://developers.aigently.ai/errors/campaign_finished.md): 409 campaign_finished
- [The campaign is not in a state this applies to](https://developers.aigently.ai/errors/campaign_status_conflict.md): 409 campaign_status_conflict
- [The number is already in the phonebook](https://developers.aigently.ai/errors/contact_exists.md): 409 contact_exists
- [Contacts lack a value the agent says out loud](https://developers.aigently.ai/errors/contacts_missing_values.md): 409 contacts_missing_values
- [The agent is still answering the last message](https://developers.aigently.ai/errors/conversation_busy.md): 409 conversation_busy
- [The conversation has ended](https://developers.aigently.ai/errors/conversation_ended.md): 409 conversation_ended
- [The conversation is still in progress](https://developers.aigently.ai/errors/conversation_in_progress.md): 409 conversation_in_progress
- [The conversation has reached its length](https://developers.aigently.ai/errors/conversation_limit_reached.md): 409 conversation_limit_reached
- [The call has not been answered yet](https://developers.aigently.ai/errors/conversation_not_answered.md): 409 conversation_not_answered
- [The website is being read](https://developers.aigently.ai/errors/crawl_running.md): 409 crawl_running
- [The credential is revoked](https://developers.aigently.ai/errors/credential_revoked.md): 409 credential_revoked
- [The number is on the do-not-call list](https://developers.aigently.ai/errors/do_not_call.md): 409 do_not_call
- [The file is already in the knowledge base](https://developers.aigently.ai/errors/duplicate_source.md): 409 duplicate_source
- [The agent has as many evaluations as it can keep](https://developers.aigently.ai/errors/evaluation_limit_reached.md): 409 evaluation_limit_reached
- [An evaluation run is already going](https://developers.aigently.ai/errors/evaluation_run_in_progress.md): 409 evaluation_run_in_progress
- [That name is taken](https://developers.aigently.ai/errors/name_taken.md): 409 name_taken
- [The source is not a file](https://developers.aigently.ai/errors/not_a_file.md): 409 not_a_file
- [The number and the agent do not fit](https://developers.aigently.ai/errors/number_agent_mismatch.md): 409 number_agent_mismatch
- [The call's window is closed](https://developers.aigently.ai/errors/outside_call_window.md): 409 outside_call_window
- [The project is frozen](https://developers.aigently.ai/errors/project_frozen.md): 409 project_frozen
- [The scheduled call has already happened](https://developers.aigently.ai/errors/scheduled_call_finished.md): 409 scheduled_call_finished
- [The scheduled call is being placed](https://developers.aigently.ai/errors/scheduled_call_placing.md): 409 scheduled_call_placing
- [The source is being indexed](https://developers.aigently.ai/errors/source_indexing.md): 409 source_indexing
- [The call is already being transferred](https://developers.aigently.ai/errors/transfer_already_requested.md): 409 transfer_already_requested
- [Not possible on this channel](https://developers.aigently.ai/errors/unsupported_channel.md): 409 unsupported_channel
- [The WhatsApp connection cannot send templates yet](https://developers.aigently.ai/errors/whatsapp_not_ready.md): 409 whatsapp_not_ready
- [The file is too large](https://developers.aigently.ai/errors/file_too_large.md): 413 file_too_large
- [The request is too large](https://developers.aigently.ai/errors/request_too_large.md): 413 request_too_large
- [Not a file the knowledge base reads](https://developers.aigently.ai/errors/unsupported_file_type.md): 415 unsupported_file_type
- [There is no number to call from](https://developers.aigently.ai/errors/caller_id_unavailable.md): 422 caller_id_unavailable
- [The conversation is too short to analyse](https://developers.aigently.ai/errors/conversation_too_short.md): 422 conversation_too_short
- [That number cannot be called](https://developers.aigently.ai/errors/destination_not_allowed.md): 422 destination_not_allowed
- [The Idempotency-Key was used for a different request](https://developers.aigently.ai/errors/idempotency_key_reused.md): 422 idempotency_key_reused
- [The variables do not fit this agent](https://developers.aigently.ai/errors/invalid_variables.md): 422 invalid_variables
- [The agent's model is set up wrongly](https://developers.aigently.ai/errors/model_misconfigured.md): 422 model_misconfigured
- [The knowledge base is full](https://developers.aigently.ai/errors/source_limit_reached.md): 422 source_limit_reached
- [Test keys can only call test numbers](https://developers.aigently.ai/errors/test_number_required.md): 422 test_number_required
- [The agent has no such version](https://developers.aigently.ai/errors/unknown_agent_version.md): 422 unknown_agent_version
- [The request has a field this endpoint does not take](https://developers.aigently.ai/errors/unknown_field.md): 422 unknown_field
- [The request did not pass validation](https://developers.aigently.ai/errors/validation_failed.md): 422 validation_failed
- [A provider credential is missing](https://developers.aigently.ai/errors/provider_key_missing.md): 424 provider_key_missing
- [Too many calls at once](https://developers.aigently.ai/errors/concurrency_limit_reached.md): 429 concurrency_limit_reached
- [The daily call limit is reached](https://developers.aigently.ai/errors/daily_limit_reached.md): 429 daily_limit_reached
- [Limits cannot be checked just now](https://developers.aigently.ai/errors/limits_unavailable.md): 429 limits_unavailable
- [Too many requests](https://developers.aigently.ai/errors/rate_limited.md): 429 rate_limited
- [Something went wrong on our side](https://developers.aigently.ai/errors/internal_error.md): 500 internal_error
- [Not available on this deployment](https://developers.aigently.ai/errors/feature_disabled.md): 501 feature_disabled
- [A service the platform depends on is not answering](https://developers.aigently.ai/errors/upstream_unavailable.md): 502 upstream_unavailable

## More

- [Glossary](https://developers.aigently.ai/glossary.md): The words the API uses, and what each means.
- [Changelog](https://developers.aigently.ai/changelog.md): What changed in the API, and the rules for what may change.

## Optional

- [OpenAPI description](https://developers.aigently.ai/openapi.v1.json): every operation and object
- [Everything in one file](https://developers.aigently.ai/llms-full.txt)