Skip to main content
POST
Python

Authorizations

superU-Api-Key
string
header
required

Your SuperU API key.

Body

application/json

Request body for Create outbound call.

Outbound Call Create Request schema.

assistant_id
string
required

Assistant ID

Example:

"ag_01HXR8FM5QYCVXAK4TYFJ4AEP0"

to
string
required

Destination number

Example:

"+14155552671"

from
string
required

Optional source number

Example:

"+14155550000"

campaign_id
string

Campaign ID

Example:

"demo_call"

customer_name
string

Customer display name

Example:

"Ava"

customer_id
string

Customer identifier

Example:

"cust_123"

variable_values
object

Key-value pairs for variables used in the agent script.

  • Variable names must exactly match those defined in the script.
  • These values replace the corresponding {{ variable_name }} placeholders in the script.

See: Agent Script – Variable Syntax

Example:

Response

Outbound call created

A generic response schema for successful API calls.

status
string

Indicates if the request was successful.

Example:

"success"

message
string

A descriptive message about the result of the request.

Example:

"Request completed successfully"

data
object

The payload of the response, if any.