Skip to main content
POST
Initiate a new call

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
agentId
string<uuid>
required

UUID of the Agent. Must exist in the database or the request fails with a 404 error.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb2"

prompt
object
required

Prompt configuration for the call.

participant
object
required

Information about the call participant.

message
object

Object containing an optional greeting call starts.

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Call created successfully"

data
object