API reference
Objects
What the API answers with.
What the API answers with. Every object says what it is in its object field, and may gain fields at any time — read the ones you know and ignore the rest.
| Object | What it is |
|---|---|
| Agent | The Agent object. |
| AgentDefinition | An agent as a document: everything about how it behaves, and everything outside it by name |
| AgentDeleted | The AgentDeleted object. |
| AgentDetail | The AgentDetail object. |
| AgentDirection | The AgentDirection object. |
| AgentKind | The AgentKind object. |
| AgentList | The AgentList object. |
| AgentPublishRequest | The AgentPublishRequest object. |
| AgentStatus | The AgentStatus object. |
| AgentVersionList | The AgentVersionList object. |
| AgentVersionObject | One published version of an agent: what pinning a conversation to it gets. |
| AgentWritten | The AgentWritten object. |
| Analysis | The Analysis object. |
| Attachment | The Attachment object. |
| AuditActor | The AuditActor object. |
| AuditEvent | One thing somebody did in the organization: in the console, or with an API key. |
| AuditEventList | The AuditEventList object. |
| CallWindow | The hours a call may start in, read in one time zone (services/calling_hours). |
| Campaign | The Campaign object. |
| CampaignCallbacks | The CampaignCallbacks object. |
| CampaignCallbacksObject | The CampaignCallbacksObject object. |
| CampaignCallingHours | The CampaignCallingHours object. |
| CampaignCallingHoursObject | The CampaignCallingHoursObject object. |
| CampaignContact | The CampaignContact object. |
| CampaignContactCreate | The CampaignContactCreate object. |
| CampaignContactList | The CampaignContactList object. |
| CampaignContactStatus | The CampaignContactStatus object. |
| CampaignContactsAdded | The CampaignContactsAdded object. |
| CampaignCounts | The CampaignCounts object. |
| CampaignList | The CampaignList object. |
| CampaignPacing | The CampaignPacing object. |
| CampaignPacingObject | The CampaignPacingObject object. |
| CampaignResume | The CampaignResume object. |
| CampaignStatus | The CampaignStatus object. |
| CampaignVoicemail | The CampaignVoicemail object. |
| CampaignVoicemailObject | The CampaignVoicemailObject object. |
| Capabilities | What this deployment of Aigently runs — a company's own copy may switch parts off. |
| Channel | The Channel object. |
| ChatTurn | One exchange: what the agent said back, and where the conversation stands after it. |
| Contact | The Contact object. |
| ContactDeleted | The ContactDeleted object. |
| ContactFields | The ContactFields object. |
| ContactImported | The ContactImported object. |
| ContactList | The ContactList object. |
| Context | What the context lookup made of an inbound call (§9.2). |
| ContextProblem | The ContextProblem object. |
| Conversation | docs/plans/public-api-and-sdks.md §6.4 — built by services/conversation_object. |
| ConversationCommandObject | Something a live call was asked to do. |
| ConversationList | The ConversationList object. |
| ConversationListItem | A conversation as the list returns it |
| ConversationMode | The ConversationMode object. |
| ConversationStatus | The ConversationStatus object. |
| ConversationWithTranscript | The ConversationWithTranscript object. |
| Cost | The Cost object. |
| CreditBalance | The CreditBalance object. |
| CreditEntryKind | The CreditEntryKind object. |
| CreditTransaction | The CreditTransaction object. |
| CreditTransactionList | The CreditTransactionList object. |
| Criterion | The Criterion object. |
| Deleted | The Deleted object. |
| DeletedConversation | The DeletedConversation object. |
| DeletedConversationList | The DeletedConversationList object. |
| Direction | The Direction object. |
| Disposition | The Disposition object. |
| DoNotCallEntry | The DoNotCallEntry object. |
| DoNotCallList | The DoNotCallList object. |
| DoNotCallRemoved | The DoNotCallRemoved object. |
| EndedBy | The EndedBy object. |
| EvaluationExpectation | The EvaluationExpectation object. |
| EvaluationExpectationCreate | The EvaluationExpectationCreate object. |
| EvaluationLatest | The EvaluationLatest object. |
| EvaluationList | The EvaluationList object. |
| EvaluationObject | A saved conversation: what a caller says, and what must be true of the agent's replies. |
| EvaluationResult | The EvaluationResult object. |
| EvaluationRunObject | One rehearsal of every saved conversation an agent has. |
| EvaluationTurn | The EvaluationTurn object. |
| EvaluationVerdict | The EvaluationVerdict object. |
| Event | One event, as a webhook receiver was sent it — under the same id. |
| EventList | The EventList object. |
| Handoff | The Handoff object. |
| Include | The Include object. |
| KnowledgeBaseList | The KnowledgeBaseList object. |
| KnowledgeBaseObject | The KnowledgeBaseObject object. |
| KnowledgeCrawl | The KnowledgeCrawl object. |
| KnowledgeCrawlList | The KnowledgeCrawlList object. |
| KnowledgeDocument | The KnowledgeDocument object. |
| KnowledgeDocumentDeleted | The KnowledgeDocumentDeleted object. |
| KnowledgeDocumentList | The KnowledgeDocumentList object. |
| KnowledgeDocumentStatus | The KnowledgeDocumentStatus object. |
| Language | The Language object. |
| Languages | The Languages object. |
| Limits | Every ceiling that applies to this key, and how much of the calls one is in use now. |
| LiveLineObject | One line of a call, as it was said. |
| LiveTranscript | What was said on a call since after, as it is said. |
| McpServerList | The McpServerList object. |
| McpServerObject | One remote MCP server whose tools an agent can be given. |
| Me | The Me object. |
| Order | The Order object. |
| OrganizationRef | The OrganizationRef object. |
| Outcome | The Outcome object. |
| PhoneNumber | The PhoneNumber object. |
| PhoneNumberList | The PhoneNumberList object. |
| Problem | RFC 9457 problem details — what every /v1 error answers with. |
| Project | The Project object. |
| ProjectList | The ProjectList object. |
| Reach | The Reach object. |
| Recording | The Recording object. |
| Removed | The Removed object. |
| ScheduledCall | The ScheduledCall object. |
| ScheduledCallList | The ScheduledCallList object. |
| ScheduledCallStatus | The ScheduledCallStatus object. |
| TestInboundCall | The TestInboundCall object. |
| TestLookup | What the agent's context lookup made of a test call. |
| ToolList | The ToolList object. |
| ToolObject | One tool: an HTTP request an agent can make mid-conversation, described for its model. |
| Transcript | The Transcript object. |
| TranscriptEntry | The TranscriptEntry object. |
| UnboundReference | The UnboundReference object. |
| VaultSecretList | The VaultSecretList object. |
| VaultSecretObject | A tool credential in the vault |
| WebCall | The WebCall object. |
| WebhookDelivery | The WebhookDelivery object. |
| WebhookDeliveryList | The WebhookDeliveryList object. |
| WebhookDeliveryStatus | The WebhookDeliveryStatus object. |
| WebhookReceiver | The WebhookReceiver object. |
| WebhookReceiverList | The WebhookReceiverList object. |
| WebhookReceiverWithSecret | The WebhookReceiverWithSecret object. |
| WebhookTest | The WebhookTest object. |
| WhatsappSenderList | The WhatsappSenderList object. |
| WhatsappSenderObject | A WhatsApp number of the organization's, and the agent that answers it. |
| WhatsappTemplateChoice | The WhatsappTemplateChoice object. |
| WhatsappTemplateList | The WhatsappTemplateList object. |
| WhatsappTemplateObject | A message template Meta has approved for the number's business account. |