agents
agents.test
conversations
data_sources
events
incidents
insights
insights.workflows
insights.tools
custom_messages
prompts
session_labels
sessions.transcript
sessions.full-summary
session_debug
channels.targets
directory
dashboards
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
takeouts
Create Agent
Create a new agent
import os
import syllable_sdk
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.agents.create(request={
"name": "Weather agent",
"description": "Agent for answering questions about weather.",
"label": "Information",
"type": "ca_v1",
"prompt_id": 1,
"custom_message_id": 1,
"language_group_id": 1,
"timezone": "America/New_York",
"prompt_tool_defaults": [
{
"tool_name": "get_weather",
"default_values": [
{
"field_name": "temperature_unit",
"default_value": "fahrenheit",
},
],
},
],
"variables": {
"vars.location_name": "Main Street Pizza",
},
"tool_headers": {
"Authorization": "Basic sometoken",
},
"stt_provider": syllable_sdk.AgentSttProvider.GOOGLE_STT_V2,
"wait_sound": syllable_sdk.AgentWaitSound.KEYBOARD_1,
})
# Handle response
print(res){
"name": "Weather agent",
"description": "Agent for answering questions about weather.",
"label": "Information",
"type": "ca_v1",
"prompt_id": 1,
"custom_message_id": 1,
"language_group_id": 1,
"timezone": "America/New_York",
"prompt_tool_defaults": {
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
},
"languages": [
"en-US",
"es-US"
],
"variables": {
"vars.location_name": "Main Street Pizza"
},
"tool_headers": {
"Authorization": "Basic sometoken"
},
"agent_initiated": false,
"stt_provider": "Google STT V1",
"wait_sound": "No Sound",
"id": 1,
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@email.com",
"prompt": {
"name": "Weather Agent Prompt",
"description": "Prompt for a weather agent.",
"type": "prompt_v1",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": "hangup",
"llm_config": {
"model": "gpt-4o",
"provider": "openai",
"version": "2024-08-06"
},
"id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated": "2024-01-01T12:00:00Z",
"last_updated_by": "user@email.com",
"agent_count": 5,
"tools_full": [
{
"name": "Weather Fetcher",
"definition": {
"endpoint": {
"argument_location": "query",
"method": "get",
"url": "https://api.open-meteo.com/v1/forecast"
},
"tool": {
"function": {
"description": "Get the weather for a city",
"name": "get_weather",
"parameters": {
"properties": {
"latitude": {
"description": "Latitude of the city",
"type": "number"
},
"longitude": {
"description": "Longitude of the city",
"type": "number"
},
"current": {
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
"description": "Information to retrieve from the open-meteo API, comma-separated",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"current"
],
"type": "object"
}
},
"type": "function"
},
"type": "endpoint"
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 1,
"name": "Test Prompt"
}
],
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com"
}
]
},
"custom_message": {
"name": "Customer service greeting",
"text": "Hello and thank you for calling customer service. How can I help you today?",
"label": "Customer service",
"rules": [
{
"date": "2025-01-01",
"description": "Closed on New Year's Day",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed today.",
"time_range_end": "17:00",
"time_range_start": "09:00"
},
{
"days_of_week": [
"sa",
"su"
],
"description": "Closed on weekends",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
"time_range_end": "17:00",
"time_range_start": "09:00"
}
],
"id": 1,
"updated_at": "2024-01-01T00:00:00Z",
"agent_count": 1,
"last_updated_by": "user@email.com",
"type": "greeting"
},
"channel_targets": [
{
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": "voice",
"fallback_target": "+19995551235",
"is_test": true,
"id": 1,
"channel_name": "+19995551234",
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@email.com",
"agent": {}
}
],
"tools": [
{
"name": "Weather Fetcher",
"definition": {
"endpoint": {
"argument_location": "query",
"method": "get",
"url": "https://api.open-meteo.com/v1/forecast"
},
"tool": {
"function": {
"description": "Get the weather for a city",
"name": "get_weather",
"parameters": {
"properties": {
"latitude": {
"description": "Latitude of the city",
"type": "number"
},
"longitude": {
"description": "Longitude of the city",
"type": "number"
},
"current": {
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
"description": "Information to retrieve from the open-meteo API, comma-separated",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"current"
],
"type": "object"
}
},
"type": "function"
},
"type": "endpoint"
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 1,
"name": "Test Prompt"
}
],
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com"
}
],
"language_group": {
"name": "Call Center 1 Languages",
"description": "Languages spoken by operators at Call Center 1",
"language_configs": [
{
"dtmf_code": 1,
"language_code": "en-US",
"voice_display_name": "Alloy",
"voice_provider": "OpenAI"
},
{
"dtmf_code": 2,
"language_code": "es-US",
"voice_display_name": "Alejandro",
"voice_provider": "Google"
}
],
"skip_current_language_in_message": true,
"id": 1,
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@mail.com"
}
}Authorizations
Body
Request model to create an agent.
The agent name
"Weather agent"
The agent type. Must be "ca_v1" currently.
"ca_v1"
ID of the prompt associated with the agent
1
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
1
The time zone in which the agent operates
"America/New_York"
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
{ "vars.location_name": "Main Street Pizza" }
Optional headers to include in tool calls for agent.
{ "Authorization": "Basic sometoken" }
The agent description
"Agent for answering questions about weather."
The agent label
"Information"
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
Agent-level static parameter values for a tool, overriding any tool-level defaults.
The name of the tool
"get_weather"
The default values for fields used in the tool
Agent-level value for a static parameter on a tool, overriding the tool-level default if one exists.
[
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
]
{
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
}
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.)
["en-US", "es-US"]
Whether the agent initiates conversation with a user after the custom message is delivered
false
Speech-to-text provider for the agent.
Google STT V1, Google STT V2, Deepgram Nova 2 "Google STT V1"
Sound to play while waiting for a response from the LLM.
No Sound, Keyboard 1, Keyboard 2, Call Center "No Sound"
Response
Response model for agent operations. When a user interacts with the Syllable system, they do so by communicating with an agent. An agent is linked to a prompt, a custom message, and one or more channel targets to define its behavior and capabilities. For more information, see Console docs.
The agent name
"Weather agent"
The agent type. Must be "ca_v1" currently.
"ca_v1"
ID of the prompt associated with the agent
1
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
1
The time zone in which the agent operates
"America/New_York"
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
{ "vars.location_name": "Main Street Pizza" }
Optional headers to include in tool calls for agent.
{ "Authorization": "Basic sometoken" }
Internal ID of the agent
1
Timestamp of most recent update
"2024-01-01T00:00:00Z"
Email of the user who last updated the agent
"user@email.com"
The agent description
"Agent for answering questions about weather."
The agent label
"Information"
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
Agent-level static parameter values for a tool, overriding any tool-level defaults.
The name of the tool
"get_weather"
The default values for fields used in the tool
Agent-level value for a static parameter on a tool, overriding the tool-level default if one exists.
[
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
]
{
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
}
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.)
["en-US", "es-US"]
Whether the agent initiates conversation with a user after the custom_message is delivered
false
Speech-to-text provider for the agent.
"Google STT V1"
Sound to play while waiting for a response from the LLM.
"No Sound"
The prompt associated with the agent.
The prompt name
"Weather Agent Prompt"
The type of the prompt
"prompt_v1"
The configuration for the LLM that the prompt uses
Provider of the LLM model.
azure_openai, google, openai Name of the model. Must match the deployment name in Azure AI Studio.
"gpt-4o"
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
1
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)
"hangup"
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
"user@email.com"
The number of agents using the prompt
5
Full definitions of tools to which the prompt has access
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see Console docs.
The name of the tool
"Weather Fetcher"
The definition of the tool
The tool definition to be used by the OpenAI API.
The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
The endpoint URL of the external service to call.
"https://api.example.com"
The HTTP method to use for the service call.
get, post How to pass the arguments to the request.
body, form, path, query 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).
A parameter for the tool whose value should be set at config time.
The name of the parameter - must be unique within the tool.
"temperature_unit"
Whether the parameter is required to have a value assigned.
true
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).
[
{
"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. Only used for context tools.
Internal ID of the service to which the tool belongs
1
The internal ID of the tool
1
The timestamp of the most recent update to the service
The email of the user who last updated the tool
"user@email.com"
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.
The name of the custom message
"Customer service greeting"
The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
"Hello and thank you for calling customer service. How can I help you today?"
The ID of the custom message
1
Timestamp of the most recent update to the custom message
"2024-01-01T00:00:00Z"
The email address of the user who most recently updated the custom message
"user@email.com"
The label of the custom message
"Customer service"
Rules for time-specific message variants
A rule used to determine whether a custom message should present a variant message based on the current timestamp.
The description of the rule
"Closed on New Year's Day"
Whether the rule logic should be inverted (i.e. "not")
false
Message text associated with the rule
"Hello, thank you for calling. Sorry, we're closed today."
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"]
[
{
"date": "2025-01-01",
"description": "Closed on New Year's Day",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed today.",
"time_range_end": "17:00",
"time_range_start": "09:00"
},
{
"days_of_week": ["sa", "su"],
"description": "Closed on weekends",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
"time_range_end": "17:00",
"time_range_start": "09:00"
}
]
The number of agents using the custom message
1
Type of the custom message (must be "greeting" for now)
"greeting"
Channel targets associated with the agent
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
1
The internal ID of the channel associated with the channel target
1
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
"+19995551234"
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
1
The name of the channel associated with the channel target
"+19995551234"
Timestamp of the most recent update to the channel target
"2024-01-01T00:00:00Z"
Email of the user who last updated the channel target
"user@email.com"
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).
true
Definition of the agent with which the channel target is associated.
The agent name
"Weather agent"
The agent type. Must be "ca_v1" currently.
"ca_v1"
ID of the prompt associated with the agent
1
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
1
The time zone in which the agent operates
"America/New_York"
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
{ "vars.location_name": "Main Street Pizza" }
Optional headers to include in tool calls for agent.
{ "Authorization": "Basic sometoken" }
Internal ID of the agent
1
Timestamp of most recent update
"2024-01-01T00:00:00Z"
Email of the user who last updated the agent
"user@email.com"
The agent description
"Agent for answering questions about weather."
The agent label
"Information"
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
Agent-level static parameter values for a tool, overriding any tool-level defaults.
The name of the tool
"get_weather"
The default values for fields used in the tool
Agent-level value for a static parameter on a tool, overriding the tool-level default if one exists.
[
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
]
{
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
}
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.)
["en-US", "es-US"]
Whether the agent initiates conversation with a user after the custom_message is delivered
false
Speech-to-text provider for the agent.
"Google STT V1"
Sound to play while waiting for a response from the LLM.
"No Sound"
The prompt associated with the agent.
The prompt name
"Weather Agent Prompt"
The type of the prompt
"prompt_v1"
The configuration for the LLM that the prompt uses
Provider of the LLM model.
azure_openai, google, openai Name of the model. Must match the deployment name in Azure AI Studio.
"gpt-4o"
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
1
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)
"hangup"
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
"user@email.com"
The number of agents using the prompt
5
Full definitions of tools to which the prompt has access
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see Console docs.
The name of the tool
"Weather Fetcher"
The definition of the tool
Internal ID of the service to which the tool belongs
1
The internal ID of the tool
1
The timestamp of the most recent update to the service
The email of the user who last updated the tool
"user@email.com"
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
IDs and names of the prompts linked to the tool
Information about a prompt linked to a tool.
IDs and names of the agents linked to the tool via a prompt
Information about an agent linked to a tool via a prompt.
The message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
The name of the custom message
"Customer service greeting"
The default message that the agent will deliver if no rules are set or no rules match the current timestamp.
"Hello and thank you for calling customer service. How can I help you today?"
The ID of the custom message
1
Timestamp of the most recent update to the custom message
"2024-01-01T00:00:00Z"
The email address of the user who most recently updated the custom message
"user@email.com"
The label of the custom message
"Customer service"
Rules for time-specific message variants
A rule used to determine whether a custom message should present a variant message based on the current timestamp.
The description of the rule
"Closed on New Year's Day"
Whether the rule logic should be inverted (i.e. "not")
false
Message text associated with the rule
"Hello, thank you for calling. Sorry, we're closed today."
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"]
[
{
"date": "2025-01-01",
"description": "Closed on New Year's Day",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed today.",
"time_range_end": "17:00",
"time_range_start": "09:00"
},
{
"days_of_week": ["sa", "su"],
"description": "Closed on weekends",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
"time_range_end": "17:00",
"time_range_start": "09:00"
}
]
The number of agents using the custom message
1
Type of the custom message (must be "greeting" for now)
"greeting"
Channel targets associated with the agent
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
1
The internal ID of the channel associated with the channel target
1
The name of the channel target. Must correspond to an organization-level target (available targets can be fetched from /channels/available-targets).
"+19995551234"
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
1
The name of the channel associated with the channel target
"+19995551234"
Timestamp of the most recent update to the channel target
"2024-01-01T00:00:00Z"
Email of the user who last updated the channel target
"user@email.com"
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).
true
Definition of the agent with which the channel target is associated.
The agent name
"Weather agent"
The agent type. Must be "ca_v1" currently.
"ca_v1"
ID of the prompt associated with the agent
1
Internal ID of the custom message that should be delivered at the beginning of a conversation with the agent
1
The time zone in which the agent operates
"America/New_York"
Custom context variables for the conversation session. Keys should be prefixed with "vars.".
{ "vars.location_name": "Main Street Pizza" }
Optional headers to include in tool calls for agent.
{ "Authorization": "Basic sometoken" }
Internal ID of the agent
1
Timestamp of most recent update
"2024-01-01T00:00:00Z"
Email of the user who last updated the agent
"user@email.com"
The agent description
"Agent for answering questions about weather."
The agent label
"Information"
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
Agent-level static parameter values for a tool, overriding any tool-level defaults.
{
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
}
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.)
["en-US", "es-US"]
Whether the agent initiates conversation with a user after the custom_message is delivered
false
Speech-to-text provider for the agent.
"Google STT V1"
Sound to play while waiting for a response from the LLM.
"No Sound"
The prompt associated with the agent.
The message associated with the agent. Will be delivered as a greeting at the beginning of a conversation.
Channel targets associated with the agent
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.
Tools associated with the agent
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see Console docs.
The language group associated with the agent
Tools associated with the agent
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see Console docs.
The name of the tool
"Weather Fetcher"
The definition of the tool
The tool definition to be used by the OpenAI API.
The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
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).
A parameter for the tool whose value should be set at config time.
[
{
"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. Only used for context tools.
Internal ID of the service to which the tool belongs
1
The internal ID of the tool
1
The timestamp of the most recent update to the service
The email of the user who last updated the tool
"user@email.com"
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
IDs and names of the agents linked to the tool via a prompt
Information about an agent linked to a tool via a prompt.
The language group associated with the agent
The name of the language group.
"Call Center 1 Languages"
Voice and DTMF configurations for each language in the group.
Voice and DTMF configurations for a language in a language group. List of available voices
and their supported languages can be fetched from GET /agents/voices/available/.
BCP 47 code of the language
yue-HK, en-US, ko-KR, zh-CN, es-US, th-TH, vi-VN TTS provider of the voice to use for the language
OpenAI, ElevenLabs, Google Display name of the voice to use for the language
Alejandro, Alice, Alloy, Ash, Bill, Brian, Callum, Charlie, Charlotte, Chris, Clara, Coral, Daniel, Echo, Eric, Fable, George, Isabella, Jerry, Jessica, Laura, Liam, Lily, Lina, Mark, Matilda, Melanie, Mila, Nova, Onyx, River, Roger, Sarah, Sage, Shimmer, Sienna, Tara, Will DTMF code that should be used for the language in the menu generated from the language group
1
[
{
"dtmf_code": 1,
"language_code": "en-US",
"voice_display_name": "Alloy",
"voice_provider": "OpenAI"
},
{
"dtmf_code": 2,
"language_code": "es-US",
"voice_display_name": "Alejandro",
"voice_provider": "Google"
}
]
Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
true
The ID of the language group to update.
1
Timestamp of the last update to the language group.
"2024-01-01T00:00:00Z"
Email of the user who last updated the language group.
"user@mail.com"
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."
IDs and names of the agents linked to the language group
Information about an agent linked to a language group.
[{ "id": 1, "name": "Test Agent" }]
Tools associated with the agent
Response model for tool operations. A tool is a function that an agent can call to perform actions like accessing databases, making API calls, or processing data. For an agent to have access to a tool, the prompt associated with that agent should be linked to the tool and include instructions to use it. For more information, see Console docs.
The name of the tool
"Weather Fetcher"
The definition of the tool
The tool definition to be used by the OpenAI API.
The tool function definition, including the JSON Schema of its parameters.
The name of the function/tool call.
"get_weather"
The description of the tool.
"Get the weather for a city"
The JSON Schema of parameters of the function/tool call.
Always function.
"function""function"
The action to take when the LLM calls the tool.
action, endpoint, context, log "endpoint"
The configuration for an HTTP API call.
The endpoint URL of the external service to call.
"https://api.example.com"
The HTTP method to use for the service call.
get, post How to pass the arguments to the request.
body, form, path, query 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).
A parameter for the tool whose value should be set at config time.
The name of the parameter - must be unique within the tool.
"temperature_unit"
Whether the parameter is required to have a value assigned.
true
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).
[
{
"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. Only used for context tools.
Internal ID of the service to which the tool belongs
1
The internal ID of the tool
1
The timestamp of the most recent update to the service
The email of the user who last updated the tool
"user@email.com"
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
The name of the language group.
"Call Center 1 Languages"
Voice and DTMF configurations for each language in the group.
Voice and DTMF configurations for a language in a language group. List of available voices
and their supported languages can be fetched from GET /agents/voices/available/.
BCP 47 code of the language
yue-HK, en-US, ko-KR, zh-CN, es-US, th-TH, vi-VN TTS provider of the voice to use for the language
OpenAI, ElevenLabs, Google Display name of the voice to use for the language
Alejandro, Alice, Alloy, Ash, Bill, Brian, Callum, Charlie, Charlotte, Chris, Clara, Coral, Daniel, Echo, Eric, Fable, George, Isabella, Jerry, Jessica, Laura, Liam, Lily, Lina, Mark, Matilda, Melanie, Mila, Nova, Onyx, River, Roger, Sarah, Sage, Shimmer, Sienna, Tara, Will DTMF code that should be used for the language in the menu generated from the language group
1
[
{
"dtmf_code": 1,
"language_code": "en-US",
"voice_display_name": "Alloy",
"voice_provider": "OpenAI"
},
{
"dtmf_code": 2,
"language_code": "es-US",
"voice_display_name": "Alejandro",
"voice_provider": "Google"
}
]
Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.
true
The ID of the language group to update.
1
Timestamp of the last update to the language group.
"2024-01-01T00:00:00Z"
Email of the user who last updated the language group.
"user@mail.com"
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."
IDs and names of the agents linked to the language group
Information about an agent linked to a language group.
[{ "id": 1, "name": "Test Agent" }]
import os
import syllable_sdk
from syllable_sdk import SyllableSDK
with SyllableSDK(
api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:
res = ss_client.agents.create(request={
"name": "Weather agent",
"description": "Agent for answering questions about weather.",
"label": "Information",
"type": "ca_v1",
"prompt_id": 1,
"custom_message_id": 1,
"language_group_id": 1,
"timezone": "America/New_York",
"prompt_tool_defaults": [
{
"tool_name": "get_weather",
"default_values": [
{
"field_name": "temperature_unit",
"default_value": "fahrenheit",
},
],
},
],
"variables": {
"vars.location_name": "Main Street Pizza",
},
"tool_headers": {
"Authorization": "Basic sometoken",
},
"stt_provider": syllable_sdk.AgentSttProvider.GOOGLE_STT_V2,
"wait_sound": syllable_sdk.AgentWaitSound.KEYBOARD_1,
})
# Handle response
print(res){
"name": "Weather agent",
"description": "Agent for answering questions about weather.",
"label": "Information",
"type": "ca_v1",
"prompt_id": 1,
"custom_message_id": 1,
"language_group_id": 1,
"timezone": "America/New_York",
"prompt_tool_defaults": {
"default_values": [
{
"default_value": "fahrenheit",
"field_name": "temperature_unit"
}
],
"tool_name": "get_weather"
},
"languages": [
"en-US",
"es-US"
],
"variables": {
"vars.location_name": "Main Street Pizza"
},
"tool_headers": {
"Authorization": "Basic sometoken"
},
"agent_initiated": false,
"stt_provider": "Google STT V1",
"wait_sound": "No Sound",
"id": 1,
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@email.com",
"prompt": {
"name": "Weather Agent Prompt",
"description": "Prompt for a weather agent.",
"type": "prompt_v1",
"context": "You are a weather agent. Answer the user's questions about weather and nothing else.",
"tools": "hangup",
"llm_config": {
"model": "gpt-4o",
"provider": "openai",
"version": "2024-08-06"
},
"id": 1,
"edit_comments": "Updated prompt text to include requirement to not answer questions that aren't about weather.",
"last_updated": "2024-01-01T12:00:00Z",
"last_updated_by": "user@email.com",
"agent_count": 5,
"tools_full": [
{
"name": "Weather Fetcher",
"definition": {
"endpoint": {
"argument_location": "query",
"method": "get",
"url": "https://api.open-meteo.com/v1/forecast"
},
"tool": {
"function": {
"description": "Get the weather for a city",
"name": "get_weather",
"parameters": {
"properties": {
"latitude": {
"description": "Latitude of the city",
"type": "number"
},
"longitude": {
"description": "Longitude of the city",
"type": "number"
},
"current": {
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
"description": "Information to retrieve from the open-meteo API, comma-separated",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"current"
],
"type": "object"
}
},
"type": "function"
},
"type": "endpoint"
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 1,
"name": "Test Prompt"
}
],
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com"
}
]
},
"custom_message": {
"name": "Customer service greeting",
"text": "Hello and thank you for calling customer service. How can I help you today?",
"label": "Customer service",
"rules": [
{
"date": "2025-01-01",
"description": "Closed on New Year's Day",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed today.",
"time_range_end": "17:00",
"time_range_start": "09:00"
},
{
"days_of_week": [
"sa",
"su"
],
"description": "Closed on weekends",
"invert": false,
"text": "Hello, thank you for calling. Sorry, we're closed on weekends.",
"time_range_end": "17:00",
"time_range_start": "09:00"
}
],
"id": 1,
"updated_at": "2024-01-01T00:00:00Z",
"agent_count": 1,
"last_updated_by": "user@email.com",
"type": "greeting"
},
"channel_targets": [
{
"agent_id": 1,
"channel_id": 1,
"target": "+19995551234",
"target_mode": "voice",
"fallback_target": "+19995551235",
"is_test": true,
"id": 1,
"channel_name": "+19995551234",
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@email.com",
"agent": {}
}
],
"tools": [
{
"name": "Weather Fetcher",
"definition": {
"endpoint": {
"argument_location": "query",
"method": "get",
"url": "https://api.open-meteo.com/v1/forecast"
},
"tool": {
"function": {
"description": "Get the weather for a city",
"name": "get_weather",
"parameters": {
"properties": {
"latitude": {
"description": "Latitude of the city",
"type": "number"
},
"longitude": {
"description": "Longitude of the city",
"type": "number"
},
"current": {
"default": "temperature_2m,relative_humidity_2m,precipitation,rain,showers",
"description": "Information to retrieve from the open-meteo API, comma-separated",
"type": "string"
}
},
"required": [
"latitude",
"longitude",
"current"
],
"type": "object"
}
},
"type": "function"
},
"type": "endpoint"
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
"service_name": "<string>",
"prompts_info": [
{
"id": 1,
"name": "Test Prompt"
}
],
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"last_updated": "2023-11-07T05:31:56Z",
"last_updated_by": "user@email.com"
}
],
"language_group": {
"name": "Call Center 1 Languages",
"description": "Languages spoken by operators at Call Center 1",
"language_configs": [
{
"dtmf_code": 1,
"language_code": "en-US",
"voice_display_name": "Alloy",
"voice_provider": "OpenAI"
},
{
"dtmf_code": 2,
"language_code": "es-US",
"voice_display_name": "Alejandro",
"voice_provider": "Google"
}
],
"skip_current_language_in_message": true,
"id": 1,
"edit_comments": "Added Spanish support.",
"agents_info": [
{
"id": 1,
"name": "Test Agent"
}
],
"updated_at": "2024-01-01T00:00:00Z",
"last_updated_by": "user@mail.com"
}
}