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
Update Tool
Update an existing tool
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.tools.update(request={
"name": "Weather Fetcher",
"definition": {
"type": syllable_sdk.Type.ENDPOINT,
"tool": {
"type": "function",
"function": {
"name": "get_weather",
"description": "Get the weather for a city",
"parameters": {
},
},
},
"endpoint": {
"url": "https://api.example.com",
"method": syllable_sdk.ToolHTTPMethod.POST,
"argument_location": syllable_sdk.ToolArgumentLocation.PATH,
},
"defaults": "<value>",
"static_parameters": [
{
"name": "temperature_unit",
"description": "Whether the temperature information should be fetched in celsius or fahrenheit.",
"required": True,
"type": syllable_sdk.StaticToolParameterType.STRING,
"default": "fahrenheit",
},
],
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
})
# Handle response
print(res){
"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"
}Authorizations
Body
Request model to update an existing tool.
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
Comments for the most recent edit to the tool.
"Updated to use new API endpoint"
Response
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
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.tools.update(request={
"name": "Weather Fetcher",
"definition": {
"type": syllable_sdk.Type.ENDPOINT,
"tool": {
"type": "function",
"function": {
"name": "get_weather",
"description": "Get the weather for a city",
"parameters": {
},
},
},
"endpoint": {
"url": "https://api.example.com",
"method": syllable_sdk.ToolHTTPMethod.POST,
"argument_location": syllable_sdk.ToolArgumentLocation.PATH,
},
"defaults": "<value>",
"static_parameters": [
{
"name": "temperature_unit",
"description": "Whether the temperature information should be fetched in celsius or fahrenheit.",
"required": True,
"type": syllable_sdk.StaticToolParameterType.STRING,
"default": "fahrenheit",
},
],
},
"service_id": 1,
"id": 1,
"last_updated_comments": "Updated to use new API endpoint",
})
# Handle response
print(res){
"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"
}