Skip to main content
POST
Create Agent

Path Parameters

vendorId
string
required

ID of the Vendor (UUID)

organizationId
string
required

ID of the Organization (UUID)

Body

application/json

Agent creation data

Data required to create a new Agent

name
string
required

Name of the agent.

Example:

"Sales Bot Alpha"

userValueTypes
object
required

Map defining user-specific value types the agent can handle.

Example:
systemPromptTemplate
string
required

Template for the system prompt used by the agent's underlying LLM.

Example:

"You are a helpful sales assistant for ACME Corp. Your goal is to qualify leads."

telephoneNumberId
string
required

ID of the telephone number assigned to this agent (UUID).

Example:

"11223344-5566-7788-9900-aabbccddeeff"

llmAudioContentGenerationStrategyId
string
required

ID of the LLM Audio Content Generation Strategy used by the agent (UUID).

Example:

"abcdef01-2345-6789-abcd-ef0123456789"

extensions
object[]
required

List of LLM extensions configured for this agent.

callEventHooks
object[]
required

List of Call Event Hooks configured for this agent.

Response

Agent successfully created

Standard API response wrapper

success
boolean
required

Indicates if the request was successful

Example:

true

timestamp
string<date-time>
required

Response timestamp in ISO-8601 format

Example:

"2025-04-17T14:23:30Z"

message
string

Human-readable message

data
object

Payload data object

traceId
string

Correlation or trace ID