agents
channels.twilio
channels.twilio.numbers
agents.test
conversations
conversation-config
data_sources
events
incidents
insights
insights.folders
insights.workflows
insights.tools
custom_messages
permissions
prompts
pronunciations
session_labels
sessions.transcript
sessions.full-summary
sessions.latency
session_debug
channels.targets
directory
dashboards
organizations
outbound.batches
- GETList Outbound Communication Batches
- POSTCreate Outbound Communication Batch
- GETGet Outbound Communication Batch
- PUTUpdate Outbound Communication Batch
- DELDelete Outbound Communication Batch
- POSTUpload Outbound Communication Batch
- GETFetch Outbound Communication Batch Results
- POSTCreate Outbound Communication Request
- POSTDelete Requests By List Of Reference Ids
outbound.campaigns
language_groups
voice_groups
import os
from syllable_sdk import SyllableSDK, models
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.channels.targets.create(channel_id=824809, channel_target_create_request={
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": models.TargetModes.EMAIL,
"fallback_target": "+19995551235",
"is_test": True,
})
# Handle response
print(res){
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"target_mode": "voice",
"id": 123,
"channel_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"fallback_target": "+19995551235",
"is_test": false,
"agent": {
"name": "<string>",
"type": "<string>",
"prompt_id": 123,
"custom_message_id": 123,
"timezone": "<string>",
"variables": {},
"tool_headers": {
"some-header": "some-value"
},
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "[email protected]",
"description": "Agent for answering questions about weather.",
"label": "Information",
"labels": [
"Information",
"Weather"
],
"language_group_id": 1,
"prompt_tool_defaults": [
{
"tool_name": "<string>",
"default_values": [
{
"field_name": "<string>",
"default_value": "<unknown>"
}
]
}
],
"languages": [
"<string>"
],
"agent_initiated": false,
"stt_provider": "Google STT V2 (Chirp 2)",
"wait_sound": "No Sound",
"prompt": {
"name": "<string>",
"type": "<string>",
"llm_config": {
"provider": "azure_openai",
"model": "gpt-4o",
"version": "2024-05-13",
"api_version": "2024-06-01",
"temperature": 1,
"seed": 123
},
"id": 123,
"last_updated": "2024-01-01T12:00:00Z",
"description": "Prompt for a weather agent.",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": [],
"session_end_enabled": false,
"session_end_tool_id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated_by": "[email protected]",
"session_end_tool": {
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
},
"agent_count": 5,
"version_number": 1,
"tools_full": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
}
]
},
"custom_message": {
"name": "<string>",
"text": "<string>",
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"label": "Customer service",
"rules": [],
"agent_count": 1,
"type": "greeting"
},
"channel_targets": [
"<unknown>"
],
"tools": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"if": {
"expression": "<string>",
"type": "cel"
},
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"if": {
"expression": "<string>",
"type": "cel"
},
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"language_group": {
"name": "<string>",
"language_configs": [
{
"language_code": "yue-HK",
"voice_provider": "OpenAI",
"voice_display_name": "Achernar (English)",
"dtmf_code": 123,
"voice_speed": 1,
"voice_pitch": 0
}
],
"skip_current_language_in_message": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"description": "Languages spoken by operators at Call Center 1",
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
]
}
}
}Assign A Channel Target
import os
from syllable_sdk import SyllableSDK, models
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.channels.targets.create(channel_id=824809, channel_target_create_request={
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": models.TargetModes.EMAIL,
"fallback_target": "+19995551235",
"is_test": True,
})
# Handle response
print(res){
"agent_id": 123,
"channel_id": 123,
"target": "<string>",
"target_mode": "voice",
"id": 123,
"channel_name": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"fallback_target": "+19995551235",
"is_test": false,
"agent": {
"name": "<string>",
"type": "<string>",
"prompt_id": 123,
"custom_message_id": 123,
"timezone": "<string>",
"variables": {},
"tool_headers": {
"some-header": "some-value"
},
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "[email protected]",
"description": "Agent for answering questions about weather.",
"label": "Information",
"labels": [
"Information",
"Weather"
],
"language_group_id": 1,
"prompt_tool_defaults": [
{
"tool_name": "<string>",
"default_values": [
{
"field_name": "<string>",
"default_value": "<unknown>"
}
]
}
],
"languages": [
"<string>"
],
"agent_initiated": false,
"stt_provider": "Google STT V2 (Chirp 2)",
"wait_sound": "No Sound",
"prompt": {
"name": "<string>",
"type": "<string>",
"llm_config": {
"provider": "azure_openai",
"model": "gpt-4o",
"version": "2024-05-13",
"api_version": "2024-06-01",
"temperature": 1,
"seed": 123
},
"id": 123,
"last_updated": "2024-01-01T12:00:00Z",
"description": "Prompt for a weather agent.",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": [],
"session_end_enabled": false,
"session_end_tool_id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated_by": "[email protected]",
"session_end_tool": {
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
},
"agent_count": 5,
"version_number": 1,
"tools_full": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": "<unknown>",
"if": "<unknown>",
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
}
]
},
"custom_message": {
"name": "<string>",
"text": "<string>",
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"label": "Customer service",
"rules": [],
"agent_count": 1,
"type": "greeting"
},
"channel_targets": [
"<unknown>"
],
"tools": [
{
"name": "<string>",
"definition": {
"tool": {
"function": {
"name": "<string>",
"description": "<string>",
"parameters": "<unknown>"
},
"type": "function"
},
"type": "endpoint",
"endpoint": {
"url": "<string>",
"method": "get",
"argument_location": "body"
},
"context": {
"task": {
"id": "<string>",
"config": {},
"variables": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
]
}
],
"metadata": {
"priority": 123,
"parent_tool_name": "<string>"
},
"tool": {
"name": "<string>",
"description": "<string>"
},
"type": "expression",
"version": "v1alpha",
"inputs": [
{
"name": "<string>",
"type": "string",
"description": "<string>",
"title": "<string>",
"format": "<string>",
"pattern": "<string>",
"enum": [
"<string>"
],
"examples": [
"<unknown>"
],
"required": true
}
],
"expression": {
"expression": "<string>",
"type": "cel"
},
"output": "<unknown>",
"on": {
"start": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"if": {
"expression": "<string>",
"type": "cel"
},
"action": "set"
}
],
"submit": [
{
"name": "<string>",
"value": "<unknown>",
"value_from": {
"expression": "<string>",
"type": "cel"
},
"if": {
"expression": "<string>",
"type": "cel"
},
"action": "set"
}
]
}
}
},
"defaults": "<unknown>",
"static_parameters": [
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
],
"result": "<unknown>",
"options": {
"propagate_tool_result": false
}
},
"service_id": 123,
"id": 123,
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 123,
"name": "<string>"
}
],
"agents_info": [
{
"id": 123,
"name": "<string>"
}
]
}
],
"language_group": {
"name": "<string>",
"language_configs": [
{
"language_code": "yue-HK",
"voice_provider": "OpenAI",
"voice_display_name": "Achernar (English)",
"dtmf_code": 123,
"voice_speed": 1,
"voice_pitch": 0
}
],
"skip_current_language_in_message": true,
"id": 123,
"updated_at": "2023-11-07T05:31:56Z",
"last_updated_by": "<string>",
"description": "Languages spoken by operators at Call Center 1",
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
]
}
}
}Authorizations
Path Parameters
Body
Request model to create a channel target.
The internal ID of the agent associated with the channel target
The internal ID of the channel associated with the channel target
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The fallback for the channel target (currently only supported for "voice" mode)
"+19995551235"
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
Response
Successful Response
Response model for channel target operations. A channel target links a channel to an agent, allowing users to communicate with the agent through that channel. For more information, see Console docs.
The internal ID of the agent associated with the channel target
The internal ID of the channel associated with the channel target
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
The mode of the channel target (must match one of the supported modes of the associated channel)
voice, chat, sms, email The internal ID of the channel target
The name of the channel associated with the channel target
Timestamp of the most recent update to the channel target
Email of the user who last updated the channel target
The fallback for the channel target (currently only supported for "voice" mode)
"+19995551235"
Whether the channel target is intended for testing. If true, any sessions created through this target will be labeled as a test session (i.e., will not be included in dashboard data and can easily be filtered out in the Sessions screen in the SyllableConsole).
Definition of the agent with which the channel target is associated.
Show child attributes
Show child attributes
The agent name
The agent type. Must be "ca_v1" currently.
ID of the prompt associated with the agent
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
The time zone in which the agent operates
Optional headers to include in tool calls for agent. (It is discouraged to use this field for "Authorization" headers, as values here are not encrypted. Instead, set up a service with either basic, bearer, or custom header auth; attach the appropriate tools to that service, and the attached tools will automatically use the auth configured on the service.)
Show child attributes
Show child attributes
{ "some-header": "some-value" }Internal ID of the agent
Timestamp of most recent update
Email of the user who last updated the agent
The agent description
"Agent for answering questions about weather."
The agent label (DEPRECATED - use labels instead.)
"Information"
The agent labels
["Information", "Weather"]Internal ID of the language group associated with the agent
1
Agent-level static parameter values for the agent's tools, overriding any tool-level defaults
Show child attributes
Show child attributes
The name of the tool
BCP 47 codes of languages the agent supports. (DEPRECATED - pass an empty list here and use language group ID to link agent to a language group instead.)
Whether the agent initiates conversation with a user after the custom_message is delivered
Speech-to-text provider for the agent.
"Google STT V2 (Chirp 2)"
Sound to play while waiting for a response from the LLM.
"No Sound"
The prompt associated with the agent.
Show child attributes
Show child attributes
The prompt name
The type of the prompt
The configuration for the LLM that the prompt uses
Show child attributes
Show child attributes
Provider of the LLM model.
azure_openai, google, openai Name of the model. Must match the deployment name in Azure AI Studio.
Optional model version.
"2024-05-13"
Version of the provider's API.
"2024-06-01"
Temperature parameter for the model. Determines randomness of responses - higher is more random, lower is more focused. Must be between 0.0 and 2.0, inclusive.
1
Controls the reproducibility of the job. The LLM will give the same or similar responses given the same inputs in multiple conversations with the same seed.
123
The internal ID of the prompt
The last updated date of the prompt
"2024-01-01T12:00:00Z"
The description of the prompt
"Prompt for a weather agent."
The prompt text that will be sent to the LLM at the beginning of the conversation
"You are a weather agent. Answer the user's questions about weather and nothing else."
Names of the tools to which the prompt has access (DEPRECATED - use information from full tools field instead)
Whether session end functionality is enabled for this prompt
ID of the optional session end tool associated with the prompt
1
The comments for the most recent edit to the prompt
"Updated prompt text to include requirement to not answer questions that aren't about weather."
Email address of the user who most recently updated the prompt
The session end tool associated with the prompt
Show child attributes
Show child attributes
The name of the tool
The definition of the tool
Show child attributes
Show child attributes
The tool definition to be used by the OpenAI API.
Show child attributes
Show child attributes
The tool function definition, including the JSON Schema of its parameters.
Show child attributes
Show child attributes
The name of the function/tool call.
The description of the tool.
The JSON Schema of parameters of the function/tool call.
Always function.
"function"The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
Show child attributes
Show child attributes
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get, post, put, delete How to pass the arguments to the request.
body, form, path, query The configuration for a context tool.
Show child attributes
Show child attributes
Task implementation details
Show child attributes
Show child attributes
A unique identifier for the task.
Show child attributes
Show child attributes
The name of the property.
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
string, number, integer, boolean, object, array, null "expression""v1alpha"Show child attributes
Show child attributes
The name of the property.
string, number, integer, boolean, object, array, null Actions to execute when the configured events occur.
Show child attributes
Show child attributes
Actions to execute on the first input from the user.
- SetValueAction
- IncrementAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"Actions to execute when the tool/step is submitted by the LLM.
- SetValueAction
- IncrementAction
- SaveAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"The default values for the parameters of the function/tool call.
Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
Show child attributes
Show child attributes
The name of the parameter - must be unique within the tool.
Whether the parameter is required to have a value assigned.
The expected type for the parameter.
string, int, boolean, data_source_list The description of the parameter.
"Whether the temperature information should be fetched in celsius or fahrenheit."
The default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names).
"fahrenheit"
[
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
]The optional result of the tool call.
The options for the tool. Ie allows to propagate the tool result to the caller via propagate_tool_result flag.
Show child attributes
Show child attributes
Whether the tool call result should be propagated to the caller.
Internal ID of the service to which the tool belongs
The internal ID of the tool
The timestamp of the most recent update to the tool
The email of the user who last updated the tool
Comments for the most recent edit to the tool.
"Updated to use new API endpoint"
The name of the service to which the tool belongs
The number of agents using the prompt
5
The version number of the current version of the prompt
1
Full definitions of tools to which the prompt has access
Show child attributes
Show child attributes
The name of the tool
The definition of the tool
Show child attributes
Show child attributes
The tool definition to be used by the OpenAI API.
Show child attributes
Show child attributes
The tool function definition, including the JSON Schema of its parameters.
Show child attributes
Show child attributes
The name of the function/tool call.
The description of the tool.
The JSON Schema of parameters of the function/tool call.
Always function.
"function"The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
Show child attributes
Show child attributes
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get, post, put, delete How to pass the arguments to the request.
body, form, path, query The configuration for a context tool.
Show child attributes
Show child attributes
Task implementation details
Show child attributes
Show child attributes
A unique identifier for the task.
Show child attributes
Show child attributes
The name of the property.
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
string, number, integer, boolean, object, array, null "expression""v1alpha"Show child attributes
Show child attributes
The name of the property.
string, number, integer, boolean, object, array, null Actions to execute when the configured events occur.
Show child attributes
Show child attributes
Actions to execute on the first input from the user.
- SetValueAction
- IncrementAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"Actions to execute when the tool/step is submitted by the LLM.
- SetValueAction
- IncrementAction
- SaveAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"The default values for the parameters of the function/tool call.
Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
Show child attributes
Show child attributes
The name of the parameter - must be unique within the tool.
Whether the parameter is required to have a value assigned.
The expected type for the parameter.
string, int, boolean, data_source_list The description of the parameter.
"Whether the temperature information should be fetched in celsius or fahrenheit."
The default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names).
"fahrenheit"
[
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
]The optional result of the tool call.
The options for the tool. Ie allows to propagate the tool result to the caller via propagate_tool_result flag.
Show child attributes
Show child attributes
Whether the tool call result should be propagated to the caller.
Internal ID of the service to which the tool belongs
The internal ID of the tool
The timestamp of the most recent update to the tool
The email of the user who last updated the tool
Comments for the most recent edit to the tool.
"Updated to use new API endpoint"
The name of the service to which the tool belongs
The message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
Show child attributes
Show child attributes
The name of the custom message
The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
The ID of the custom message
Timestamp of the most recent update to the custom message
The email address of the user who most recently updated the custom message
The label of the custom message
"Customer service"
Rules for time-specific message variants
Show child attributes
Show child attributes
The description of the rule
Whether the rule logic should be inverted (i.e. "not")
Message text associated with the rule
The start of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
"09:00"
The end of the time range for the rule in 24-hour format hh:mm (should be null for "all day" cases)
"17:00"
The date for the rule in YYYY-MM-DD format
"2025-01-01"
The days of the week for the rule
Available options for day of the week for use in message rules.
mo, tu, we, th, fr, sa, su ["mo", "tu", "we", "th", "fr"]The number of agents using the custom message
1
Type of the custom message (must be "greeting" for now)
Channel targets associated with the agent
Tools associated with the agent
Show child attributes
Show child attributes
The name of the tool
The definition of the tool
Show child attributes
Show child attributes
The tool definition to be used by the OpenAI API.
Show child attributes
Show child attributes
The tool function definition, including the JSON Schema of its parameters.
Show child attributes
Show child attributes
Always function.
"function"The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
Show child attributes
Show child attributes
The endpoint URL of the external service to call.
The HTTP method to use for the service call.
get, post, put, delete How to pass the arguments to the request.
body, form, path, query The configuration for a context tool.
Show child attributes
Show child attributes
Task implementation details
Show child attributes
Show child attributes
A unique identifier for the task.
Show child attributes
Show child attributes
The name of the property.
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
string, number, integer, boolean, object, array, null "expression""v1alpha"Show child attributes
Show child attributes
The name of the property.
string, number, integer, boolean, object, array, null Actions to execute when the configured events occur.
Show child attributes
Show child attributes
Actions to execute on the first input from the user.
- SetValueAction
- IncrementAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"Actions to execute when the tool/step is submitted by the LLM.
- SetValueAction
- IncrementAction
- SaveAction
- CallAction
- SayAction
Show child attributes
Show child attributes
Destination path to mutate (e.g. output.foo).
Initial value of the variable.
Expression to compute initial value (mutually exclusive with value).
An expression that must evaluate to true for the action to be applied.
"set"The default values for the parameters of the function/tool call.
Parameters for the tool whose values should be set at config time (i.e., not provided by the LLM).
Show child attributes
Show child attributes
The name of the parameter - must be unique within the tool.
Whether the parameter is required to have a value assigned.
The expected type for the parameter.
string, int, boolean, data_source_list The description of the parameter.
"Whether the temperature information should be fetched in celsius or fahrenheit."
The default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names).
"fahrenheit"
[
{
"default": "fahrenheit",
"description": "Whether the temperature information should be fetched in Celsius or Fahrenheit",
"name": "temperature_unit",
"required": false,
"type": "string"
}
]The optional result of the tool call.
The options for the tool. Ie allows to propagate the tool result to the caller via propagate_tool_result flag.
Show child attributes
Show child attributes
Whether the tool call result should be propagated to the caller.
Internal ID of the service to which the tool belongs
The internal ID of the tool
The timestamp of the most recent update to the tool
The email of the user who last updated the tool
Comments for the most recent edit to the tool.
"Updated to use new API endpoint"
The name of the service to which the tool belongs
The language group associated with the agent
Show child attributes
Show child attributes
The name of the language group.
Voice and DTMF configurations for each language in the group.
Show child attributes
Show child attributes
BCP 47 code of the language
yue-HK, en-US, ko-KR, zh-CN, fa-IR, es-US, th-TH, vi-VN, bs-BA, sw-KE, ru-RU, hi-IN, gu-IN TTS provider of the voice to use for the language
OpenAI, ElevenLabs, Google Display name of the voice to use for the language
Achernar (English), Achernar (Gujarati), Achernar (Hindi), Achernar (Korean), Achernar (Mandarin), Achernar (Spanish), Achernar (Thai), Achernar (Vietnamese), Alice, Alloy, Aoede (English), Aoede (Gujarati), Aoede (Hindi), Aoede (Korean), Aoede (Mandarin), Aoede (Russian), Aoede (Spanish), Aoede (Thai), Aoede (Vietnamese), Ash, Bill, Brian, Callirrhoe (English), Callirrhoe (Gujarati), Callirrhoe (Hindi), Callirrhoe (Korean), Callirrhoe (Mandarin), Callirrhoe (Spanish), Callirrhoe (Thai), Callirrhoe (Vietnamese), Callum, Charlie, Charlotte, Charon (English), Charon (Gujarati), Charon (Hindi), Charon (Korean), Charon (Mandarin), Charon (Russian), Charon (Spanish), Charon (Thai), Charon (Vietnamese), Chris, cmn-TW-Wavenet-A, Coral, Daniel, Echo, en-US-Neural2-D, en-US-Neural2-F, en-US-Neural2-J, en-US-Studio-O, Eric, es-US-Neural2-A, es-US-Neural2-B, Fable, Fenrir (English), Fenrir (Gujarati), Fenrir (Hindi), Fenrir (Korean), Fenrir (Mandarin), Fenrir (Russian), Fenrir (Spanish), Fenrir (Thai), Fenrir (Vietnamese), George, Jessica, ko-KR-Neural2-A, Kore (English), Kore (Gujarati), Kore (Hindi), Kore (Korean), Kore (Mandarin), Kore (Russian), Kore (Spanish), Kore (Thai), Kore (Vietnamese), Laura, Leda (English), Leda (Gujarati), Leda (Hindi), Leda (Korean), Leda (Mandarin), Leda (Russian), Leda (Spanish), Leda (Thai), Leda (Vietnamese), Liam, Lily, Matilda, Nova, Onyx, Orus (English), Orus (Gujarati), Orus (Hindi), Orus (Korean), Orus (Mandarin), Orus (Russian), Orus (Spanish), Orus (Thai), Orus (Vietnamese), Puck (English), Puck (Gujarati), Puck (Hindi), Puck (Korean), Puck (Mandarin), Puck (Russian), Puck (Spanish), Puck (Thai), Puck (Vietnamese), River, Roger, Sarah, Sage, Shimmer, Umbriel (English), Umbriel (Gujarati), Umbriel (Hindi), Umbriel (Korean), Umbriel (Mandarin), Umbriel (Spanish), Umbriel (Thai), Umbriel (Vietnamese), Vindemiatrix (English), Vindemiatrix (Gujarati), Vindemiatrix (Hindi), Vindemiatrix (Korean), Vindemiatrix (Mandarin), Vindemiatrix (Spanish), Vindemiatrix (Thai), Vindemiatrix (Vietnamese), vi-VN-Neural2-A, Will, yue-HK-Standard-C, Zephyr (English), Zephyr (Gujarati), Zephyr (Hindi), Zephyr (Korean), Zephyr (Mandarin), Zephyr (Russian), Zephyr (Spanish), Zephyr (Thai), Zephyr (Vietnamese) DTMF code that should be used for the language in the menu generated from the language group.
Speed of the voice in the range of 0.25 to 4.0 (OpenAI and Google) or 0.7 to 1.2 (ElevenLabs). Standard speed is 1.0.
1
Pitch of the voice in the range of -20.0 to 20.0. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. 0 means use the original pitch. Only supported for Google configs.
0
Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
The ID of the language group to update.
Timestamp of the last update to the language group.
Email of the user who last updated the language group.
Description of the language group.
"Languages spoken by operators at Call Center 1"
Comments for the most recent edit to the language group.
"Added Spanish support."