API reference

Every operation of the Aigently API.

Every operation, by what it is about. Each page lists its parameters, its body, its answer and its errors, with an example in seven languages and a Try it that takes a test key.

Requests go to https://api.aigently.ai, with an API key in Authorization: Bearer <key>. The whole description is the OpenAPI file.

Keys

Operation	Request
Describe this API key	`GET /v1/me`

Projects

Operation	Request
List projects	`GET /v1/projects`

Agents

Operation	Request
List agents	`GET /v1/agents`
Create an agent	`POST /v1/agents`
Get an agent	`GET /v1/agents/{agent_id}`
Delete an agent	`DELETE /v1/agents/{agent_id}`
Get an agent's definition	`GET /v1/agents/{agent_id}/definition`
Replace an agent's definition	`PUT /v1/agents/{agent_id}/definition`
Publish an agent	`POST /v1/agents/{agent_id}/publish`
List an agent's versions	`GET /v1/agents/{agent_id}/versions`
Get a published version's definition	`GET /v1/agents/{agent_id}/versions/{version}/definition`

Evaluations

Operation	Request
Run an agent's evaluations	`POST /v1/agents/{agent_id}/evaluation-runs`
List an agent's evaluations	`GET /v1/agents/{agent_id}/evaluations`
Add an evaluation	`POST /v1/agents/{agent_id}/evaluations`
Delete an evaluation	`DELETE /v1/agents/{agent_id}/evaluations/{evaluation_id}`
Get an evaluation run	`GET /v1/evaluation-runs/{run_id}`

Phone numbers

Operation	Request
List phone numbers	`GET /v1/phone-numbers`
Point a phone number at an agent	`PATCH /v1/phone-numbers/{phone_number_id}`

Calls

Operation	Request
Place a call	`POST /v1/calls`
End a conversation	`POST /v1/conversations/{conversation_id}/end`

Scheduled calls

Operation	Request
List scheduled calls	`GET /v1/scheduled-calls`
Schedule a call	`POST /v1/scheduled-calls`
Get a scheduled call	`GET /v1/scheduled-calls/{scheduled_call_id}`
Cancel a scheduled call	`DELETE /v1/scheduled-calls/{scheduled_call_id}`

Campaigns

Operation	Request
List campaigns	`GET /v1/campaigns`
Create a campaign	`POST /v1/campaigns`
Get a campaign	`GET /v1/campaigns/{campaign_id}`
Cancel a campaign	`POST /v1/campaigns/{campaign_id}/cancel`
List a campaign's contacts	`GET /v1/campaigns/{campaign_id}/contacts`
Add contacts to a campaign	`POST /v1/campaigns/{campaign_id}/contacts`
Pause a campaign	`POST /v1/campaigns/{campaign_id}/pause`
Resume a campaign	`POST /v1/campaigns/{campaign_id}/resume`
Start a campaign	`POST /v1/campaigns/{campaign_id}/start`

Contacts

Operation	Request
List contacts	`GET /v1/contacts`
Add a contact	`POST /v1/contacts`
Import contacts	`POST /v1/contacts/import`
Get a contact	`GET /v1/contacts/{contact_id}`
Change a contact	`PATCH /v1/contacts/{contact_id}`
Delete a contact	`DELETE /v1/contacts/{contact_id}`

Knowledge

Operation	Request
List knowledge bases	`GET /v1/knowledge-bases`
List the websites a knowledge base reads	`GET /v1/knowledge-bases/{knowledge_base_id}/crawls`
Read a website again	`POST /v1/knowledge-bases/{knowledge_base_id}/crawls/{crawl_id}/refresh`
List a knowledge base's sources	`GET /v1/knowledge-bases/{knowledge_base_id}/documents`
Add a file to a knowledge base	`POST /v1/knowledge-bases/{knowledge_base_id}/documents`
Get a source	`GET /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}`
Replace a file	`PUT /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}`
Delete a source	`DELETE /v1/knowledge-bases/{knowledge_base_id}/documents/{document_id}`

Tools

Operation	Request
List MCP servers	`GET /v1/mcp-servers`
Add an MCP server	`POST /v1/mcp-servers`
Get an MCP server	`GET /v1/mcp-servers/{server_id}`
Change an MCP server	`PATCH /v1/mcp-servers/{server_id}`
Delete an MCP server	`DELETE /v1/mcp-servers/{server_id}`
List tools	`GET /v1/tools`
Create a tool	`POST /v1/tools`
Get a tool	`GET /v1/tools/{tool_id}`
Change a tool	`PATCH /v1/tools/{tool_id}`
Delete a tool	`DELETE /v1/tools/{tool_id}`

Vault

Operation	Request
List tool credentials	`GET /v1/vault/secrets`
Add a tool credential	`POST /v1/vault/secrets`
Get a tool credential	`GET /v1/vault/secrets/{secret_id}`
Change a tool credential	`PATCH /v1/vault/secrets/{secret_id}`
Delete a tool credential	`DELETE /v1/vault/secrets/{secret_id}`

Do not call

Operation	Request
List the do-not-call list	`GET /v1/do-not-call`
Add a number to the do-not-call list	`POST /v1/do-not-call`
Take a number off the do-not-call list	`DELETE /v1/do-not-call/{number}`

Chats

Operation	Request
Upload a picture	`POST /v1/attachments`
Start a chat	`POST /v1/chats`
Send a message	`POST /v1/conversations/{conversation_id}/messages`

Operation	Request
Start a WhatsApp conversation	`POST /v1/whatsapp/conversations`
List WhatsApp numbers	`GET /v1/whatsapp/senders`
List a WhatsApp number's templates	`GET /v1/whatsapp/senders/{sender_id}/templates`

Web calls

Operation	Request
Start a browser call	`POST /v1/web-calls`

Conversations

Operation	Request
List conversations	`GET /v1/conversations`
List deleted conversations	`GET /v1/conversations/deleted`
Get a conversation	`GET /v1/conversations/{conversation_id}`
Delete a conversation	`DELETE /v1/conversations/{conversation_id}`
Analyse a conversation again	`POST /v1/conversations/{conversation_id}/analysis`
Get a link to a conversation's recording	`GET /v1/conversations/{conversation_id}/recording`
Get a conversation's transcript	`GET /v1/conversations/{conversation_id}/transcript`

Live calls

Operation	Request
Get a command	`GET /v1/conversations/{conversation_id}/commands/{command_id}`
Follow a call's transcript live	`GET /v1/conversations/{conversation_id}/live`
Give the agent a note	`POST /v1/conversations/{conversation_id}/notes`
Have the agent say something	`POST /v1/conversations/{conversation_id}/say`
Transfer a call	`POST /v1/conversations/{conversation_id}/transfer`

Events

Operation	Request
List events	`GET /v1/events`

Webhooks

Operation	Request
List webhook receivers	`GET /v1/webhooks`
Create a webhook receiver	`POST /v1/webhooks`
Get a webhook receiver	`GET /v1/webhooks/{receiver_id}`
Change a webhook receiver	`PATCH /v1/webhooks/{receiver_id}`
Delete a webhook receiver	`DELETE /v1/webhooks/{receiver_id}`
List a receiver's deliveries	`GET /v1/webhooks/{receiver_id}/deliveries`
Send a delivery again	`POST /v1/webhooks/{receiver_id}/deliveries/{delivery_id}/resend`
Change a webhook receiver's secret	`POST /v1/webhooks/{receiver_id}/rotate-secret`
Send a test event	`POST /v1/webhooks/{receiver_id}/test`

Billing

Operation	Request
Get the credit balance	`GET /v1/billing/balance`
List credit transactions	`GET /v1/billing/transactions`

Audit log

Operation	Request
List audit events	`GET /v1/audit-events`

Test mode

Operation	Request
Make a test call to an agent	`POST /v1/test/inbound-calls`

The objects these answer with are listed under Objects.