Skip to main content
POST
Create Agent

Create Agent

Create a new AI agent with custom configuration. Define the agent’s name, general prompt, and optional webhook settings for call completion callbacks.
string
required
Bearer token in the format: Bearer {access_token}
string
required
Must be set to application/json
string
required
A descriptive name for your AI agent
string
required
The main system prompt that defines the agent’s behavior and purpose. This guides how the agent interacts during calls.
string
Optional callback URL that will be called when the agent completes a call. Leave empty if not needed.
string
HTTP method for the webhook callback. Must be either GET or POST. Defaults to POST if not specified.
string
Unique identifier for the newly created agent
string
The name of the created agent
string
Status of the agent creation (typically “active” or “pending”)
The general_prompt is crucial for defining your agent’s behavior. Make sure it clearly describes the agent’s purpose, tone, and objectives for best results.

Authorizations

Authorization
string
header
required

Bearer token authentication. Include the access token in the Authorization header as 'Bearer {access_token}'

Body

application/json
agent_name
string
required

A descriptive name for your AI agent

general_prompt
string
required

The main system prompt that defines the agent's behavior and purpose. This guides how the agent interacts during calls.

weebhook_endpoint
string<uri>

Optional callback URL that will be called when the agent completes a call. Leave empty if not needed.

weebhook_endpoint_method
enum<string>
default:POST

HTTP method for the webhook callback. Must be either GET or POST. Defaults to POST if not specified.

Available options:
GET,
POST

Response

Agent created successfully

agent_id
string
required

Unique identifier for the newly created agent

agent_name
string
required

The name of the created agent

status
string
required

Status of the agent creation (typically 'active' or 'pending')