Create Call Agent
Create a new agent for a workspace.
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Request Body
namestringrequiredName of the agent being created.
ttsModelobjectrequiredText-to-Speech (TTS) configuration for the agent.
smartCallbackbooleandefault: falseEnable smart callback functionality for the agent.
maxAttemptsForSmartCallbacknumberdefault: 5Maximum number of callback attempts when smart callback is enabled.
gapBetweenEachAttemptForSmartCallbackarrayArray of time intervals between each callback attempt. Each item contains days and hours.
phoneNumberIdsarrayArray of phone number IDs to associate with the agent.
llmModelstringrequireddefault: gpt-4o-miniLanguage Model to be used by the agent to generate responses. Must be one of: gpt-4o-mini, gpt-4o, gpt-4o-enterprise, gpt-4.1, gpt-4.1-mini, gpt-4.1-enterprise, gpt-4.1-mini-enterprise, gemini-2.5-flash, gemini-2.0-flash-001.
settingsobjectAdditional settings for the agent.
variablesobjectCustom variables to store for the agent.
Response Fields
_idstringUnique identifier for the newly created agent.
workspaceIdstringWorkspace ID associated with the agent.
userIdstringUser ID of the agent creator.
namestringName of the agent.
ttsModelobjectText-to-Speech configuration for the agent.
providerstringTTS provider used by the agent.
voiceIdstringdefault: mistv2_WildflowerVoice ID used for generating speech. (e.g., mistv2_Brook, mistv2_Violet, mistv2_Wildflower)
languagestringLanguage code of the TTS voice.
elevenLabsApiKeystringEncrypted ElevenLabs API key (only present if provider is "11labs_byo").
llmModelstringLanguage Model used by the agent to generate responses.
smartCallbackbooleanWhether smart callback is enabled for the agent.
maxAttemptsForSmartCallbacknumberMaximum number of callback attempts.
gapBetweenEachAttemptForSmartCallbackarrayArray of time intervals between callback attempts.
phoneNumberIdsarrayArray of phone number IDs associated with the agent.
activeSessionsarrayArray of active sessions for the agent.
settingsobjectAdditional settings configured for the agent.
statusstringCurrent status of the agent (pending, ready, or error).
currentNodestringCurrent node or state within the agent's flow.
variablesobjectCustom variables stored for the agent.
createdAtstringTimestamp when the agent was created.
updatedAtstringTimestamp when the agent was last updated.
{
"name": "Customer Support Agent",
"ttsModel": {
"provider": "rime",
"voiceId": "mistv2_Wildflower",
"name": "Sophie",
"language": "en"
},
"llmModel": "gpt-4o",
"type": "voice",
"smartCallback": true,
"maxAttemptsForSmartCallback": 3,
"gapBetweenEachAttemptForSmartCallback": [
{ "days": 1, "hours": 2 },
{ "days": 2, "hours": 0 },
{ "days": 3, "hours": 6 }
],
"settings": {
"speed": 0.8,
"volume": 1,
"temperature": 0.7
}
}