Skip to main content
POST

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Body

application/json
voiceAgentId
string<uuid>
required

The agent to call.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

versionRef
string

Optional. The version to run: a version ID, draft (your own draft), or draft:<draftId> (a proposed draft; needs the agents:review_drafts permission). Omit it to run what the environment, or prod, serves. Not with a public key.

Required string length: 1 - 100
Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

environmentId
string<uuid>

Optional. The environment whose version and values the call uses. Not with a public key (it uses its own environment).

Example:

"5b9d1e7f-2c3a-4f8b-8d16-7e9f0a1b2c3d"

isChatOnly
boolean

Optional. true for a text chat instead of a voice call.

Example:

false

callerKey
string

Optional. A stable ID for the person calling (for example their user ID in your system), so their calls land on the same side of an A/B test.

Required string length: 1 - 200
Example:

"user-48213"

Response

Token created.

success
boolean
Example:

true

message
string
Example:

"success"

data
object