Platform APIAgents

Create an agent

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
agentobjectRequired
namestringRequired
Agent name.
typeenumRequired
Agent type.
Allowed values:
descriptionstringOptional
Agent description.
end_call_reasons_v2list of objectsOptional

Custom conditions that trigger automatic call termination with per-reason closing message control. When both end_call_reasons and end_call_reasons_v2 are present, v2 takes precedence.

external_webhook_urlstringOptional
URL of the webhook that should receive data after the call, such as the transcript.
inbound_call_webhook_urlstringOptional

The URL for your inbound webhook. For more details on inbound webhooks, see About inbound call webhooks.

is_recordingbooleanOptional
Whether the conversation should be recorded.
max_durationobjectOptional
phone_numberstringOptional
The phone number attached to the agent.
voicemail_messageobjectOptional

Configuration for the message left when a voicemail is detected. Requires greeting_message_mode to be set to human.

end_call_reasonslist of stringsOptionalDeprecated

Deprecated: use end_call_reasons_v2 instead. Custom conditions that trigger automatic call termination (simple string array format).

Response

200
statusstring
Whether the request was successful.
responseobject
detailsobject

Errors

400
Bad Request Error