Agents

Create an agent

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
typeenumRequired
Type of assistant to be created.
Allowed values:
namestringRequired
Name of the call recipient.
agentobjectRequired
phone_numberstringOptional
Phone number.
caller_id_numberstringOptional

The number of the caller ID, i.e. +12345678901

external_webhook_urlstringOptional

URL of the webhook that should receive data after the call. (Transcript etc.)

is_recordingbooleanOptional

Indicates whether the conversation should be recorded. If yes, you’ll find the log in the Calls section.

is_transcript_disabledbooleanOptionalDefaults to false
Disable transcription of conversations. Transcripts will not be generated or stored.
consent_recordingbooleanOptional
If enabled, the agent will ask for consent to record the call
consent_textstringOptional
The message the agent will say to ask for consent for recording

Response

200
statusstring or null
responseobject or null
detailsobject or null

Errors