Skip to main content
POST
Create Assistant

Path Parameters

vendorId
string
required

ID of the Vendor (UUID)

organizationId
string
required

ID of the Organization (UUID)

Body

application/json

Assistant creation data

Data required to create a new Assistant

name
string
required

Name of the assistant.

Example:

"Help Desk Assistant"

systemPromptGreeting
string
required

Initial greeting message from the assistant.

Example:

"Hello! How can I help you with our products today?"

systemPrompt
string
required

Main system prompt defining the assistant's role and behavior.

Example:

"You are a customer support assistant for ACME Gadgets. Be polite, helpful, and concise. Escalate complex issues to a human agent if necessary."

llmAudioContentGenerationStrategyId
string
required

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

Example:

"abcdef01-2345-6789-abcd-ef0123456789"

extensions
object[]
required

List of LLM extensions configured for this assistant.

callEventHooks
object[]
required

List of Call Event Hooks configured for this assistant.

telephoneNumberId
string

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

Example:

"11223344-5566-7788-9900-aabbccddeeff"

Response

Assistant 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