AigentlyDevelopers

Quickstart API reference Console

Get started

Overview
Quickstart
Going live
The command line

Guides

Outbound calls
Variables
Inbound calls
Chat and streaming
Reading and syncing conversations
Webhooks
The event feed
Test mode
Rate limits
Safe retries
API keys
Signing visitors in the widget
Credit and billing
Phone numbers
Campaigns
Contacts
Knowledge
Browser calls
AI assistants (MCP)
Audit log
Agents as code
Tools and credentials
Evaluations in your pipeline
Terraform
Mobile apps
Live calls
WhatsApp conversations

API reference

Overview
Objects

Keys

Describe this API key

Projects

List projects

Agents

List agents
Create an agent
Get an agent
Delete an agent
Get an agent's definition
Replace an agent's definition
Publish an agent
List an agent's versions
Get a published version's definition

Evaluations

Run an agent's evaluations
List an agent's evaluations
Add an evaluation
Delete an evaluation
Get an evaluation run

Phone numbers

List phone numbers
Point a phone number at an agent

Calls

Place a call
End a conversation

Scheduled calls

List scheduled calls
Schedule a call
Get a scheduled call
Cancel a scheduled call

Campaigns

List campaigns
Create a campaign
Get a campaign
Cancel a campaign
List a campaign's contacts
Add contacts to a campaign
Pause a campaign
Resume a campaign
Start a campaign

Contacts

List contacts
Add a contact
Import contacts
Get a contact
Change a contact
Delete a contact

Knowledge

List knowledge bases
List the websites a knowledge base reads
Read a website again
List a knowledge base's sources
Add a file to a knowledge base
Get a source
Replace a file
Delete a source

Tools

List MCP servers
Add an MCP server
Get an MCP server
Change an MCP server
Delete an MCP server
List tools
Create a tool
Get a tool
Change a tool
Delete a tool

Vault

List tool credentials
Add a tool credential
Get a tool credential
Change a tool credential
Delete a tool credential

Do not call

List the do-not-call list
Add a number to the do-not-call list
Take a number off the do-not-call list

Chats

Upload a picture
Start a chat
Send a message

WhatsApp

Start a WhatsApp conversation
List WhatsApp numbers
List a WhatsApp number's templates

Web calls

Start a browser call

Conversations

List conversations
List deleted conversations
Get a conversation
Delete a conversation
Analyse a conversation again
Get a link to a conversation's recording
Get a conversation's transcript

Live calls

Get a command
Follow a call's transcript live
Give the agent a note
Have the agent say something
Transfer a call

Events

List events

Webhooks

List webhook receivers
Create a webhook receiver
Get a webhook receiver
Change a webhook receiver
Delete a webhook receiver
List a receiver's deliveries
Send a delivery again
Change a webhook receiver's secret
Send a test event

Billing

Get the credit balance
List credit transactions

Audit log

List audit events

Test mode

Make a test call to an agent

Errors

Every error code

More

Glossary
Changelog

All pages

Get started

Overview
Quickstart
Going live
The command line

Guides

Outbound calls
Variables
Inbound calls
Chat and streaming
Reading and syncing conversations
Webhooks
The event feed
Test mode
Rate limits
Safe retries
API keys
Signing visitors in the widget
Credit and billing
Phone numbers
Campaigns
Contacts
Knowledge
Browser calls
AI assistants (MCP)
Audit log
Agents as code
Tools and credentials
Evaluations in your pipeline
Terraform
Mobile apps
Live calls
WhatsApp conversations

API reference

Overview
Objects

Keys

Describe this API key

Projects

List projects

Agents

List agents
Create an agent
Get an agent
Delete an agent
Get an agent's definition
Replace an agent's definition
Publish an agent
List an agent's versions
Get a published version's definition

Evaluations

Run an agent's evaluations
List an agent's evaluations
Add an evaluation
Delete an evaluation
Get an evaluation run

Phone numbers

List phone numbers
Point a phone number at an agent

Calls

Place a call
End a conversation

Scheduled calls

List scheduled calls
Schedule a call
Get a scheduled call
Cancel a scheduled call

Campaigns

List campaigns
Create a campaign
Get a campaign
Cancel a campaign
List a campaign's contacts
Add contacts to a campaign
Pause a campaign
Resume a campaign
Start a campaign

Contacts

List contacts
Add a contact
Import contacts
Get a contact
Change a contact
Delete a contact

Knowledge

List knowledge bases
List the websites a knowledge base reads
Read a website again
List a knowledge base's sources
Add a file to a knowledge base
Get a source
Replace a file
Delete a source

Tools

List MCP servers
Add an MCP server
Get an MCP server
Change an MCP server
Delete an MCP server
List tools
Create a tool
Get a tool
Change a tool
Delete a tool

Vault

List tool credentials
Add a tool credential
Get a tool credential
Change a tool credential
Delete a tool credential

Do not call

List the do-not-call list
Add a number to the do-not-call list
Take a number off the do-not-call list

Chats

Upload a picture
Start a chat
Send a message

WhatsApp

Start a WhatsApp conversation
List WhatsApp numbers
List a WhatsApp number's templates

Web calls

Start a browser call

Conversations

List conversations
List deleted conversations
Get a conversation
Delete a conversation
Analyse a conversation again
Get a link to a conversation's recording
Get a conversation's transcript

Live calls

Get a command
Follow a call's transcript live
Give the agent a note
Have the agent say something
Transfer a call

Events

List events

Webhooks

List webhook receivers
Create a webhook receiver
Get a webhook receiver
Change a webhook receiver
Delete a webhook receiver
List a receiver's deliveries
Send a delivery again
Change a webhook receiver's secret
Send a test event

Billing

Get the credit balance
List credit transactions

Audit log

List audit events

Test mode

Make a test call to an agent

Errors

Every error code

More

Glossary
Changelog

API reference

Direction

The Direction object.

View as Markdown

One of: inbound, outbound.