agents
channels.twilio.numbers
agents.test
conversations
data_sources
events
incidents
insights
insights.folders
insights.workflows
insights.tools
custom_messages
prompts
session_labels
sessions.transcript
sessions.full-summary
sessions.latency
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
prompts
Prompt List
List the existing prompts
GET
/
api
/
v1
/
prompts
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.prompts.list(page=0, search_fields=[
syllable_sdk.PromptProperties.NAME,
], search_field_values=[
"Some Object Name",
], start_datetime="2023-01-01T00:00:00Z", end_datetime="2024-01-01T00:00:00Z")
# Handle response
print(res)
{
"items": [
{
"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"
}
]
}
],
"page": 0,
"page_size": 25,
"total_pages": 4,
"total_count": 100
}
Authorizations
Query Parameters
The page number from which to start (0-based)
Required range:
x >= 0
Examples:
0
The maximum number of items to return
Required range:
x >= 0
Examples:
25
String names of fields to search. Correspond by index to search field values
Examples:
"name"
Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
Examples:
"Some Object Name"
The field whose value should be used to order the results
Available options:
id
, name
, name_exact
, description
, name_description
, context
, tools
, llm_config
, last_updated
, last_updated_by
, agent_count
Examples:
"name"
The direction in which to order the results
Available options:
asc
, desc
The fields to include in the response
The start datetime for filtering results
Examples:
"2023-01-01T00:00:00Z"
The end datetime for filtering results
Examples:
"2024-01-01T00:00:00Z"
Response
200
application/json
Successful Response
The response is of type object
.
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.prompts.list(page=0, search_fields=[
syllable_sdk.PromptProperties.NAME,
], search_field_values=[
"Some Object Name",
], start_datetime="2023-01-01T00:00:00Z", end_datetime="2024-01-01T00:00:00Z")
# Handle response
print(res)
{
"items": [
{
"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"
}
]
}
],
"page": 0,
"page_size": 25,
"total_pages": 4,
"total_count": 100
}