For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
You can create a new agent by passing the name of the agent in the request body. You can use update-workflow endpoint next to assign custom workflow to the agent.
Authentication
AuthorizationBearer
API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.
Language configuration for the agent. You can enable or disable language switching for the agent. This will be used to determine the language of the agent.
synthesizerobjectOptional
Synthesizer configuration for the agent. You can configure the synthesizer to use different voices and models. Currently we support 3 types of models for the synthesizer. Waves, Waves Lightning Large and Waves Lightning Large Voice Clone. You can clone your voice using waves platform https://waves.smallest.ai/voice-clone and use the voiceId for this field and select the model as waves_lightning_large_voice_clone to use your cloned voice. When updating the synthesizer configuration to voice clone model, you have to provide model and voiceId and gender all are required fields but when selecting the model as waves or waves and waves_lightning_large, you have to provide only model field and voiceId.
globalKnowledgeBaseIdstringOptional
The global knowledge base ID of the agent. You can create a global knowledge base by using the /knowledgebase endpoint and assign it to the agent. The agent will use this knowledge base for its responses.
slmModelenumOptionalDefaults to electron
The LLM model to use for the agent. LLM model will be used to generate the response and take decisions based on the user's query.
Allowed values:
defaultVariablesobjectOptional
The default variables to use for the agent. These variables will be used if no variables are provided when initiating a conversation with the agent.
preCallAPIobjectOptional
Configuration for an API call to be made before the call starts. The response variables can be injected into the agent's prompt.
globalPromptstringOptional
Set global instructions for your agent’s personality, role, and behavior throughout conversations.
Note: Only used for workflow_graph agents.
telephonyProductIdstringOptional
The telephony product ID of the agent. This is the product ID of the telephony product that will be used to make the outbound call. You can buy telephone number and assign it to the agent.
workflowTypeenumOptional
The type of workflow to create for the agent. Defaults to workflow_graph if not specified.
Allowed values:
firstMessagestringOptional<=500 characters
The first message the agent sends when a conversation starts.
muteUserUntilFirstBotResponsebooleanOptional
When true, the user's audio is muted until the agent has finished its first response.
allowInterruptionsbooleanOptional
Whether the user can interrupt the agent while it is speaking.
waitForUserToSpeakFirstbooleanOptional
When true, the agent waits for the user to speak before sending the first message.
interruptionBackoffTimerdoubleOptional0-10
Seconds the agent waits after being interrupted before resuming speech.
smartTurnConfigobjectOptional
Smart turn-detection configuration. When enabled, the agent uses an additional model to decide whether the user has finished a turn.
voiceDetectionConfigobjectOptional
Voice activity detection (VAD) configuration. Controls how the agent decides when speech is present.
voiceMailDetectionConfigobjectOptional
Voicemail-detection configuration. When the call hits a voicemail tone, the agent plays endText and ends the call.
denoisingConfigobjectOptional
Background-noise denoising configuration for the agent’s input audio.
redactionConfigobjectOptional
PII redaction configuration. When enabled, personally identifiable information is redacted from transcripts before storage.
pronunciationDictslist of objectsOptional
Pronunciation overrides — words the TTS engine should pronounce differently from its default.
llmIdleTimeoutConfigobjectOptional
Timeout configuration for the LLM stage of a conversation. Triggers a retry or call termination when the LLM does not respond within the configured window.
sessionTimeoutConfigobjectOptional
Maximum duration of a conversation session. The call ends after this elapsed time even if active.
timezoneobjectOptional
Timezone applied to scheduled actions and timestamps the agent reports to the user.
