Dynamic Agent Setup

Dynamic setup schemas for configuring AI assistants across different channels. Provides streamlined setup flows for phone and web deployments with channel-specific configurations.

Source: src/core/service-configuration/dynamic_setup/

---

DynamicBaseAgentSetup

Base schema for AI assistant configuration, used for both phone and web channels.

Schema: DynamicBaseAgentSetupSchema

Attributes

Attribute	Type	Required	Default	Description
assistantName	string	Yes	—	Name of the AI assistant (max 30 characters)
instructionConfigurationId	string	No	—	ID of instruction configuration to use
role_template_identifier	AgentRoleTemplateIdentifier	No	—	Role/persona template
capabilities	array<AgentCapabilities>	No	[]	Enabled platform services
knowledgeSourceIds	array<string>	No	—	Associated knowledge source IDs
language	string	No	en	Language ID (e.g., en, es, fr)
voice	string	No	—	Voice ID for voice interactions
providerType	SupportedProprietor | null	No	—	AI model provider
providerModelId	string | null	No	—	Specific model ID from provider

---

DynamicPhoneAgentSetup

Phone-specific agent setup extending base configuration.

Schema: DynamicPhoneAgentSchema

Additional Attributes

Attribute	Type	Required	Default	Description
phoneConfigurationId	string | null	No	—	Phone configuration ID
testPhoneNumber	string | null	No	—	Phone number for testing
sttConfiguration	DynamicSTTModelConfiguration | null	No	—	Speech-to-text config
ttsConfiguration	DynamicTTSModelConfiguration | null	No	—	Text-to-speech config

Validation: Both sttConfiguration and ttsConfiguration must be provided together or neither.

---

DynamicWebAgentSetup

Web-specific agent setup extending base configuration.

Schema: DynamicWebAgentSchema

Additional Attributes

Attribute	Type	Required	Default	Description
websiteUrl	string	Yes	—	URL of the website
communicationType	OttCommunicationType	No	UNIFIED	Communication method
sttConfiguration	DynamicSTTModelConfiguration | null	No	—	Speech-to-text config
ttsConfiguration	DynamicTTSModelConfiguration | null	No	—	Text-to-speech config

---

Model Configurations

DynamicModelConfiguration

Base model configuration.

Attribute	Type	Description
providerType	SupportedProprietor	AI model provider
providerModelId	string	Provider's model ID

DynamicSTTModelConfiguration

Speech-to-text model configuration.

Attribute	Type	Default	Description
providerType	SupportedProprietor	—	AI model provider
providerModelId	string	—	Provider's model ID
languageId	string	en	Language for speech recognition

DynamicTTSModelConfiguration

Text-to-speech model configuration.

Attribute	Type	Default	Description
providerType	SupportedProprietor	—	AI model provider
providerModelId	string	—	Provider's model ID
languageId	string	en	Language for synthesis
voiceId	string	—	Voice ID for output

---

DynamicAgentProcessingState

Tracks long-running setup operations.

Attributes

Attribute	Type	Description
status	enum	Current status (pending, in_progress, completed, failed)
progressPercentage	number	Progress percentage (0-100)
message	string	Additional state details

---

Setup Results

DynamicAgentSetupResult

Base result for agent setup operations.

Attribute	Type	Description
id	string	Result record ID
processingState	DynamicAgentProcessingState	Real-time processing state
success	boolean | null	Whether setup was successful
agentConfigurationId	string | null	Created agent configuration ID
instructionConfigurationId	string | null	Created instruction configuration ID
errorMessage	string	Error message if failed
metadata	object | null	Additional metadata

DynamicPhoneAgentSetupResult

Extends base result with phone number.

Attribute	Type	Description
phoneNumber	string | null	Associated phone number

DynamicWebAgentSetupResult

Extends base result with integration snippets.

Attribute	Type	Description
integrationSnippets	array<string> | null	Code snippets for deployment

---

Example

Phone Agent Setup

{
  "assistantName": "Sarah",
  "role_template_identifier": "CUSTOMER_SUPPORT",
  "capabilities": ["APPOINTMENT_BOOKING"],
  "language": "en",
  "phoneConfigurationId": "phone_abc123",
  "sttConfiguration": {
    "providerType": "OPENAI",
    "providerModelId": "whisper-1",
    "languageId": "en"
  },
  "ttsConfiguration": {
    "providerType": "ELEVENLABS",
    "providerModelId": "eleven_multilingual_v2",
    "languageId": "en",
    "voiceId": "adam"
  }
}

Web Agent Setup

{
  "assistantName": "Alex",
  "role_template_identifier": "SALES_ASSISTANT",
  "capabilities": ["ORDER_MANAGEMENT"],
  "language": "en",
  "websiteUrl": "https://example.com",
  "communicationType": "UNIFIED"
}

---

Update Schemas

Schema	Description
UpdateDynamicPhoneAgentSchema	Partial update for phone agent (excludes phoneConfigurationId)
UpdateDynamicWebAgentSchema	Partial update for web agent

---

Related

• Agent Configuration - Created by setup process
• Instruction Configuration - Created by setup process
• Provisioning Config - Voice chain configuration