Headers
API key used for authenticating requests to the API.
Workspace identifier for the API.
Request Body
Name of the agent being created.
Text-to-Speech (TTS) configuration for the agent.
Enable smart callback functionality for the agent.
Maximum number of callback attempts when smart callback is enabled.
Array of time intervals between each callback attempt. Each item contains days and hours.
Array of phone number IDs to associate with the agent.
Language Model to be used by the agent to generate responses. Must be one of: gpt-4o-mini, gpt-4o-enterprise, gpt-4.1, gpt-4.1-mini, gemini-2.5-flash-preview-native-audio-dialog, gemini-2.5-flash, gemini-live-2.5-flash-preview, geminiaudiopipeline:gemini-2.5-flash-preview-native-audio-dialog, gemini-2.0-flash-live-001, gpt-5.
Additional settings for the agent.
Custom variables to store for the agent.
Response Fields
Unique identifier for the newly created agent.
Workspace ID associated with the agent.
User ID of the agent creator.
Name of the agent.
Text-to-Speech configuration for the agent.
TTS provider used by the agent.
Voice ID used for generating speech. (e.g., mistv2_Brook, mistv2_Violet, mistv2_Wildflower)
Language code of the TTS voice.
Encrypted ElevenLabs API key (only present if provider is “11labs_byo”).
Language Model used by the agent to generate responses.
Whether smart callback is enabled for the agent.
Maximum number of callback attempts.
Array of time intervals between callback attempts.
Array of phone number IDs associated with the agent.
Array of active sessions for the agent.
Additional settings configured for the agent.
Current status of the agent (pending, ready, or error).
Current node or state within the agent’s flow.
Custom variables stored for the agent.
Timestamp when the agent was created.
Timestamp when the agent was last updated.
