syllable-sdk 0.1.0-alpha.29 → 0.1.0-alpha.30

package/docs/openapi.json

@@ -0,0 +1 @@
+{"openapi":"3.1.0","info":{"title":"SyllableSDK","description":"\n# Syllble Platform SDK\n\nSyllble SDK gives you the power of awesome AI agentry. 🚀\n\n## Overview\n\nThe Syllble SDK provides a comprehensive set of tools and APIs to integrate powerful AI capabilities into your applications. Whether you're building chatbots, virtual assistants, or any other AI-driven solutions, Syllble SDK has got you covered.\n\n## Features\n\n- **Natural Language Processing (NLP)**: Understand and generate human language with ease.\n- **Machine Learning Models**: Leverage pre-trained models or train your own custom models.\n- **Speech Recognition**: Convert speech to text and vice versa.\n- **Image Recognition**: Identify objects, faces, and scenes in images.\n- **Data Analytics**: Analyze and visualize data to gain insights.\n- **Integration**: Seamlessly integrate with other services and platforms.\n\n","version":"0.0.2"},"servers":[{"url":"http://localhost:8001"}],"paths":{"/api/v1/agents/":{"get":{"tags":["agents"],"summary":"Agent List","description":"List the existing agents","operationId":"agent_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"filter_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Name"}},{"name":"filter_prompt","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Prompt"}},{"name":"filter_greeting","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Greeting"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["agents"],"summary":"Create Agent","description":"Create a new agent","operationId":"agent_create","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["agents"],"summary":"Update Agent","description":"Update an existing agent","operationId":"agent_update","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/agents/{agent_id}":{"get":{"tags":["agents"],"summary":"Get Agent By Id","description":"Get an agent by ID.","operationId":"agent_get_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"integer","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Agent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["agents"],"summary":"Delete Agent","description":"Delete an agent by ID","operationId":"agent_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"integer","title":"Agent Id"}},{"name":"reason","in":"query","required":true,"schema":{"type":"string","title":"Reason"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/available-targets":{"get":{"tags":["channels.targets"],"summary":"Available Targets List","description":"List the available phone numbers","operationId":"available_targets","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailableTargetsListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/":{"get":{"tags":["channels"],"summary":"Get Channels","operationId":"channels_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/targets":{"get":{"tags":["channels.targets"],"summary":"Get Channel Targets","operationId":"channel_targets_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"target","title":"Order By"}},{"name":"order_by_direction","in":"query","required":false,"schema":{"type":"string","default":"DESC","title":"Order By Direction"}},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"}},{"name":"channel_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Id"}},{"name":"target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"}},{"name":"fallback_target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Target"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTargetListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/{channel_id}/targets":{"post":{"tags":["channels.targets"],"summary":"Assign A Channel Target","operationId":"channel_targets_create","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"integer","title":"Channel Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTargetCreateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTarget"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/{channel_id}/targets/{target_id}":{"get":{"tags":["channels.targets"],"summary":"Get A Channel Target","operationId":"channel_targets_get_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"integer","title":"Channel Id"}},{"name":"target_id","in":"path","required":true,"schema":{"type":"integer","title":"Target Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTarget"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["channels.targets"],"summary":"Edit Channel Target","description":"Update channel target by ID","operationId":"channels_target_update","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"integer","title":"Channel Id"}},{"name":"target_id","in":"path","required":true,"schema":{"type":"integer","title":"Target Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTarget"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTarget"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/channels/{channel_id}":{"delete":{"tags":["channels"],"summary":"Delete Channel","description":"Delete channel by ID","operationId":"channels_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"channel_id","in":"path","required":true,"schema":{"type":"string","title":"Channel Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelTarget"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chats/messages":{"post":{"tags":["agents.chats"],"summary":"Send New Message","description":"Send a new message","operationId":"chats_send_message","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/conversations/":{"get":{"tags":["conversations"],"summary":"Conversations List","operationId":"conversations_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"timestamp","title":"Order By"}},{"name":"order_by_direction","in":"query","required":false,"schema":{"type":"string","default":"DESC","title":"Order By Direction"}},{"name":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Time"}},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Time"}},{"name":"agent_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type"}},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"}},{"name":"prompt_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Id"}},{"name":"call_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Id"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"target","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"}},{"name":"is_legacy","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Legacy"}},{"name":"is_test","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Test"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/conversations/{conversation_id}":{"get":{"tags":["conversations"],"summary":"Get Conversation By Id","operationId":"conversation_get_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","title":"Conversation Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationTranscriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboards/total_call_volume_by_weekday":{"get":{"tags":["dashboards"],"summary":"Get Total Call Volume By Weekday","description":"Get total call volume by weekday.","operationId":"total_call_volume_by_weekday","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Total Call Volume By Weekday"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_total_call_volume_by_hour":{"get":{"tags":["dashboards"],"summary":"Get Total Call Volume By Hour","description":"Get total call volume by hour.","operationId":"get_total_call_volume_by_hour","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Total Call Volume By Hour"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_weekly_call_volume_by_weekday":{"get":{"tags":["dashboards"],"summary":"Get Weekly Call Volume By Weekday","description":"Get weekly call volume by weekday.","operationId":"get_weekly_call_volume_by_weekday","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Weekly Call Volume By Weekday"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_daily_call_volume_by_hour":{"get":{"tags":["dashboards"],"summary":"Get Daily Call Volume By Hour","description":"Get daily call volume by hour.","operationId":"get_daily_call_volume_by_hour","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Daily Call Volume By Hour"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_monthly_call_volume_by_week":{"get":{"tags":["dashboards"],"summary":"Get Monthly Call Volume By Week","description":"Get monthly cal volume by week.","operationId":"get_monthly_call_volume_by_week","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Monthly Call Volume By Week"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_monthly_call_volume_by_day":{"get":{"tags":["dashboards"],"summary":"Get Monthly Call Volume By Day","description":"Get monthly call volume by day.","operationId":"get_monthly_call_volume_by_day","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Monthly Call Volume By Day"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/dashboards/get_session_summary":{"get":{"tags":["dashboards"],"summary":"Get Session Summary","description":"Get session summary data","operationId":"get_session_summary","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Start Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"End Date"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"agent_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Session Summary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/dashboards/get_agents":{"get":{"tags":["dashboards"],"summary":"Get Agents","description":"Get list of agents for session summary dropdown","operationId":"get_session_agents","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Session Agents"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v1/events/":{"get":{"tags":["events"],"summary":"Events List","operationId":"events_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},{"name":"conversation_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"}},{"name":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"}},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/greetings/":{"get":{"tags":["greetings"],"summary":"Greetings List","description":"List the existing greetings","operationId":"greetings_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GreetingListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["greetings"],"summary":"Create Greeting","description":"Create a new greeting","operationId":"greetings_create","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GreetingCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GreetingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["greetings"],"summary":"Update Greeting","description":"Update a greeting","operationId":"greetings_update","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Greeting"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GreetingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/greetings/{greeting_id}":{"get":{"tags":["greetings"],"summary":"Get Greeting By Id","description":"Get the greeting by its ID","operationId":"greetings_get_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"greeting_id","in":"path","required":true,"schema":{"type":"integer","title":"Greeting Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GreetingResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["greetings"],"summary":"Delete Greeting","description":"Delete greeting by ID","operationId":"greetings_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"greeting_id","in":"path","required":true,"schema":{"type":"integer","title":"Greeting Id"}},{"name":"reason","in":"query","required":true,"schema":{"type":"string","title":"Reason"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prompts/":{"get":{"tags":["prompts"],"summary":"Prompt List","description":"List the existing prompts","operationId":"prompts_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"filter_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Name"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["prompts"],"summary":"Create Prompt","description":"Create a new prompt","operationId":"prompts_create","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromptCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prompt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["prompts"],"summary":"Update Prompt","description":"Update an existing prompt","operationId":"prompts_update","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prompt"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prompt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/prompts/{prompt_id}":{"get":{"tags":["prompts"],"summary":"Get Prompt By Id","description":"Get a prompt by ID","operationId":"prompts_get_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"prompt_id","in":"path","required":true,"schema":{"type":"integer","title":"Prompt Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prompt"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["prompts"],"summary":"Delete Prompt","description":"Delete an prompt by ID","operationId":"prompts_delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"prompt_id","in":"path","required":true,"schema":{"type":"integer","title":"Prompt Id"}},{"name":"reason","in":"query","required":true,"schema":{"type":"string","title":"Reason"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/sessions/":{"get":{"tags":["sessions"],"summary":"Sessions List","operationId":"sessions_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"channel_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Type"}},{"name":"channel_service","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Service"}},{"name":"start_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"}},{"name":"end_time","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"}},{"name":"include_legacy","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Legacy"}},{"name":"include_test","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Test"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/":{"get":{"tags":["tools"],"summary":"Tool List","description":"List the existing agents","operationId":"tool_list","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"default":0,"title":"Page"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":-1,"default":-1,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/tools/{tool_name}":{"get":{"tags":["tools"],"summary":"Tool Info","description":"Get the details of a specific tool","operationId":"tool_get_by_name","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"tool_name","in":"path","required":true,"schema":{"type":"string","title":"Tool Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToolDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/organizations/":{"get":{"tags":["organizations"],"summary":"Organizations List","description":"List all organizations","operationId":"organizations_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Organization"},"type":"array","title":"Response Organizations List"}}}}},"security":[{"APIKeyHeader":[]}]}}},"components":{"schemas":{"Agent":{"properties":{"name":{"type":"string","title":"Name"},"timezone":{"type":"string","title":"Timezone"},"type_extra":{"type":"object","title":"Type Extra"},"variables":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Variables"},"id":{"type":"integer","title":"Id","description":"The Agent ID"}},"type":"object","required":["name","timezone","type_extra","id"],"title":"Agent"},"AgentCreate":{"properties":{"name":{"type":"string","title":"Name"},"timezone":{"type":"string","title":"Timezone"},"type_extra":{"type":"object","title":"Type Extra"},"variables":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Variables"}},"type":"object","required":["name","timezone","type_extra"],"title":"AgentCreate"},"AgentListResponse":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/Agent"},"type":"array","title":"Agents"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["agents","count"],"title":"AgentListResponse"},"AvailableTarget":{"properties":{"channel_id":{"type":"integer","title":"Channel Id"},"channel_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Name"},"target":{"type":"string","title":"Target"}},"type":"object","required":["channel_id","channel_name","target"],"title":"AvailableTarget"},"AvailableTargetsListResponse":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/AvailableTarget"},"type":"array","title":"Targets"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["targets","page","page_size","total_pages","total_count"],"title":"AvailableTargetsListResponse"},"Channel":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"channel_service":{"type":"string","title":"Channel Service"},"supported_modes":{"type":"string","title":"Supported Modes"}},"type":"object","required":["id","name","channel_service","supported_modes"],"title":"Channel"},"ChannelListResponse":{"properties":{"channels":{"items":{"$ref":"#/components/schemas/Channel"},"type":"array","title":"Channels"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["channels","page","page_size","total_pages","total_count"],"title":"ChannelListResponse"},"ChannelTarget":{"properties":{"id":{"type":"integer","title":"Id"},"channel_id":{"type":"integer","title":"Channel Id"},"channel_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Name"},"agent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Agent Id"},"target":{"type":"string","title":"Target"},"target_mode":{"type":"string","title":"Target Mode"},"fallback_target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Target"},"is_test":{"type":"boolean","title":"Is Test"}},"type":"object","required":["id","channel_id","channel_name","agent_id","target","target_mode","fallback_target","is_test"],"title":"ChannelTarget"},"ChannelTargetCreateRequest":{"properties":{"channel_id":{"type":"integer","title":"Channel Id"},"channel_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Name"},"agent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Agent Id"},"target":{"type":"string","title":"Target"},"target_mode":{"type":"string","title":"Target Mode"},"fallback_target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fallback Target"},"is_test":{"type":"boolean","title":"Is Test"}},"type":"object","required":["channel_id","channel_name","agent_id","target","target_mode","fallback_target","is_test"],"title":"ChannelTargetCreateRequest"},"ChannelTargetListResponse":{"properties":{"targets":{"items":{"$ref":"#/components/schemas/ChannelTarget"},"type":"array","title":"Targets"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["targets","page","page_size","total_pages","total_count"],"title":"ChannelTargetListResponse"},"ChatMessage":{"properties":{"service_name":{"type":"string","title":"Service Name","description":"Name of the service producing the message"},"source_name":{"type":"string","title":"Source Name","description":"Name of the source of the message, should identify the user, like an email or username"},"chat_id":{"type":"string","title":"Chat Id"},"agent_id":{"type":"string","title":"Agent Id"},"org_name":{"type":"string","title":"Org Name"},"text":{"type":"string","title":"Text"}},"type":"object","required":["service_name","source_name","chat_id","agent_id","org_name","text"],"title":"ChatMessage"},"ChatMessageResponse":{"properties":{"chat_id":{"type":"string","title":"Chat Id"},"agent_id":{"type":"string","title":"Agent Id"},"text":{"type":"string","title":"Text"},"response":{"type":"object","title":"Response"}},"type":"object","required":["chat_id","agent_id","text"],"title":"ChatMessageResponse"},"Conversation":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"conversation_id":{"type":"string","title":"Conversation Id"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"agent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Id"},"agent_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Name"},"agent_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Type"},"prompt_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Id"},"prompt_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Name"},"prompt_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Version"},"call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call Id"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"},"is_legacy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Legacy"},"is_test":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Test"}},"type":"object","required":["timestamp","conversation_id"],"title":"Conversation"},"ConversationAction":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"tool_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Name"},"tool_request":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Request"},"tool_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Result"}},"type":"object","required":["timestamp"],"title":"ConversationAction"},"ConversationListResponse":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/Conversation"},"type":"array","title":"Conversations"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["conversations","page","page_size","total_pages","total_count"],"title":"ConversationListResponse"},"ConversationText":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"lang":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lang"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"}},"type":"object","required":["timestamp"],"title":"ConversationText"},"ConversationTranscriptionResponse":{"properties":{"conversation_id":{"type":"string","title":"Conversation Id"},"transcription":{"items":{"$ref":"#/components/schemas/ConversationText"},"type":"array","title":"Transcription"},"actions":{"items":{"$ref":"#/components/schemas/ConversationAction"},"type":"array","title":"Actions"}},"type":"object","required":["conversation_id","transcription","actions"],"title":"ConversationTranscriptionResponse"},"Defaults":{"properties":{"anyof_schema_1_validator":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Anyof Schema 1 Validator"},"anyof_schema_2_validator":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ToolParameterDefault"},"type":"object"},{"type":"null"}],"title":"Anyof Schema 2 Validator"},"actual_instance":{"title":"Actual Instance"},"any_of_schemas":{"items":{"type":"string"},"type":"array","uniqueItems":true,"title":"Any Of Schemas","default":["object","Dict[str, ToolParameterDefault]"]}},"type":"object","title":"Defaults","description":"The default values for the parameters of the function/tool call."},"Event":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"source_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Id"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"attributes":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attributes"}},"type":"object","required":["timestamp"],"title":"Event"},"EventListResponse":{"properties":{"events":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Events"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["events","page","page_size","total_pages","total_count"],"title":"EventListResponse"},"Function":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the function/tool call."},"description":{"type":"string","title":"Description","description":"The description of the tool."},"parameters":{"type":"object","title":"Parameters","description":"The JSON Schema of parameters of the function/tool call."}},"type":"object","required":["name","description","parameters"],"title":"Function","description":"A tool definition to be used by the OpenAI API.  See: - https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling"},"Greeting":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the greeting"},"text":{"type":"string","title":"Text","description":"The text of the greeting"},"id":{"type":"integer","title":"Id","description":"The ID of the greeting"}},"type":"object","required":["name","text","id"],"title":"Greeting","description":"Greeting"},"GreetingCreate":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the greeting"},"text":{"type":"string","title":"Text","description":"The text of the greeting"}},"type":"object","required":["name","text"],"title":"GreetingCreate","description":"GreetingCreate"},"GreetingListResponse":{"properties":{"greetings":{"items":{"$ref":"#/components/schemas/Greeting"},"type":"array","title":"Greetings"}},"type":"object","required":["greetings"],"title":"GreetingListResponse"},"GreetingResponse":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the greeting"},"text":{"type":"string","title":"Text","description":"The text of the greeting"},"id":{"type":"integer","title":"Id","description":"The ID of the greeting"}},"type":"object","required":["name","text","id"],"title":"GreetingResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HttpEndpoint":{"properties":{"url":{"type":"string","title":"Url","description":"The endpoint URL of the external service to call."},"method":{"type":"string","title":"Method","description":"The HTTP method to use for the service call."},"argument_location":{"type":"string","title":"Argument Location","description":"How to pass the arguments to the request."}},"type":"object","required":["url","method","argument_location"],"title":"HttpEndpoint","description":"The configuration for an HTTP API call."},"LlmConfig":{"properties":{"provider":{"anyOf":[{"$ref":"#/components/schemas/Provider"},{"type":"null"}],"description":"Provider of the LLM model."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Name of the model. Must match the deployment name in Azure AI Studio.","default":"gpt-4o"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"api_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Api Version"}},"type":"object","title":"LlmConfig","description":"LlmConfig"},"Organization":{"properties":{"id":{"type":"integer","title":"Id","description":"The organization ID"},"name":{"type":"string","title":"Name","description":"The organization name"},"display_name":{"type":"string","title":"Display Name","description":"The organization display name"}},"type":"object","required":["id","name","display_name"],"title":"Organization"},"Prompt":{"properties":{"name":{"type":"string","title":"Name","description":"The Prompt name"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"tools":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tools","description":"The tools for the prompt"},"llm_config":{"allOf":[{"$ref":"#/components/schemas/LlmConfig"}],"description":"The configuration for the language model used by the Cortex API."},"id":{"type":"integer","title":"Id","description":"The Prompt ID"},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated"}},"type":"object","required":["name","llm_config","id","last_updated"],"title":"Prompt","description":"Prompt"},"PromptCreate":{"properties":{"name":{"type":"string","title":"Name","description":"The Prompt name"},"context":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Context"},"tools":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tools","description":"The tools for the prompt"},"llm_config":{"allOf":[{"$ref":"#/components/schemas/LlmConfig"}],"description":"The configuration for the language model used by the Cortex API."}},"type":"object","required":["name","llm_config"],"title":"PromptCreate","description":"PromptCreate"},"PromptListResponse":{"properties":{"prompts":{"items":{"$ref":"#/components/schemas/Prompt"},"type":"array","title":"Prompts"},"filter_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Name"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["prompts","filter_name","page","page_size","total_pages","total_count"],"title":"PromptListResponse"},"Provider":{"type":"string","enum":["azure_openai","openai"],"title":"Provider","description":"LLM API provider."},"SchemasBubblegumV2ToolsTool":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the tool"},"definition":{"anyOf":[{"$ref":"#/components/schemas/ToolDefinition"},{"type":"null"}],"description":"The definition of the tool"},"service_id":{"type":"integer","title":"Service Id","description":"The service this tool belongs to"},"id":{"type":"integer","title":"Id","description":"The ID of the tool"},"service_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Service Name"}},"type":"object","required":["name","service_id","id"],"title":"SchemasBubblegumV2ToolsTool","description":"SchemasBubblegumV2ToolsTool"},"SchemasCortexV1ToolsTool":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type","description":"Always `function`.","default":"function"},"function":{"allOf":[{"$ref":"#/components/schemas/Function"}],"description":"The tool definition including the JSON Schema of its parameters."}},"type":"object","required":["function"],"title":"SchemasCortexV1ToolsTool","description":"A tool definition to be used by the OpenAI API."},"Session":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id"},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"channel_manager_service":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Manager Service"},"channel_manager_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Manager Type"},"channel_manager_sid":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel Manager Sid"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"target":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target"},"is_legacy":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Legacy"},"is_test":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Test"}},"type":"object","required":["timestamp"],"title":"Session"},"SessionListResponse":{"properties":{"sessions":{"items":{"$ref":"#/components/schemas/Session"},"type":"array","title":"Sessions"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["sessions","page","page_size","total_pages","total_count"],"title":"SessionListResponse"},"ToolDefinition":{"properties":{"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"tool":{"allOf":[{"$ref":"#/components/schemas/SchemasCortexV1ToolsTool"}],"description":"The tool definition to be used by the OpenAI API."},"endpoint":{"anyOf":[{"$ref":"#/components/schemas/HttpEndpoint"},{"type":"null"}]},"defaults":{"anyOf":[{"$ref":"#/components/schemas/Defaults"},{"type":"null"}]},"result":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Result"}},"type":"object","required":["tool"],"title":"ToolDefinition","description":"A tool that can be called from GPT during the conversation.  The tool can result in one of the following actions depending on the `type` field: - `action`:   An `ActionRequest` to return to Bubblegum in `GetResponseResponse`. - `endpoint`:   An HTTP API call to an external tool. Requires the `endpoint` field to be set too. - `context`:   Sets context variables based on the tool arguments, e.g. to change the session language. Only   `language` and `say` context vars are currently supported, but this will be made more generic.  For example, to change the current session language: ``` {   \"type\": \"context\",   \"tool\": {     \"function\": {       \"name\": \"set_language\",       \"parameters\": {         \"language\": {           \"type\": \"string\",           \"description\": \"The ISO 639 language code to set for the session e.g. 'en-US'.\"         },         \"message\": {           \"type\": \"string\",           \"description\": \"Inform the caller we're now speaking in the new language.\"         }       }     }   } } ```  If `defaults` is provided, it will be used as the default values for the parameters of the tool call, if GPT doesn't provide them: ``` \"defaults\": {   \"hospital\": \"Queens Hospital\" } ```  Some special \"transform\" handling is supported if the value is a dict with a single `transform` key. The parameter value will be transformed by the given `action` before being used as the default value:  Removing an unwanted parameter: ``` \"defaults\": {   \"hospital\": {     \"transform\": {       \"action\": \"remove\"     }   } } ```  Add custom parameters from other parameters using Python's `format`: ``` \"defaults\": {   \"hello\": {     \"transform\": {       \"format\": \"Hello, {name}!\"     }   } }  Modify a value conditionally, e.g. change a `city` parameter with value \"Bronx\" to \"The Bronx\": ``` {   \"defaults\": {     \"city\": {       \"transform\": {         \"when\": {\"operator\": \"eq\", \"key\": \"city\", \"value\": \"Bronx\"},         \"action\": \"override\",         \"format\": \"The {city}\"       }     }   } } ```"},"ToolDetailResponse":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"fields":{"items":{"type":"string"},"type":"array","title":"Fields"}},"type":"object","required":["name","description","fields"],"title":"ToolDetailResponse"},"ToolListResponse":{"properties":{"tools":{"items":{"$ref":"#/components/schemas/SchemasBubblegumV2ToolsTool"},"type":"array","title":"Tools"},"page":{"type":"integer","title":"Page"},"page_size":{"type":"integer","title":"Page Size"},"total_pages":{"type":"integer","title":"Total Pages"},"total_count":{"type":"integer","title":"Total Count"}},"type":"object","required":["tools","page","page_size","total_pages","total_count"],"title":"ToolListResponse"},"ToolParameterDefault":{"properties":{"transform":{"allOf":[{"$ref":"#/components/schemas/ToolParameterTransform"}],"description":"The transform to apply to the value before using it as the default."}},"type":"object","required":["transform"],"title":"ToolParameterDefault","description":"The default value for a parameter of the tool call."},"ToolParameterTransform":{"properties":{"when":{"anyOf":[{"$ref":"#/components/schemas/ToolParameterTransformCondition"},{"type":"null"}]},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Action","description":"The action to perform on the value: `default` means only set the value (using the `format` field) if the parameter doesn't exist or is empty, `override` means always set the value, and `remove` means remove the parameter value.","default":"default"},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}},"type":"object","title":"ToolParameterTransform","description":"A transform to be applied to the value of a parameter."},"ToolParameterTransformCondition":{"properties":{"key":{"type":"string","title":"Key","description":"The name of the parameter to check."},"value":{"type":"string","title":"Value","description":"The value to check against the parameter."},"operator":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Operator"}},"type":"object","required":["key","value"],"title":"ToolParameterTransformCondition","description":"A condition to be met for a transform to be applied to the value of a parameter."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"Syllable-API-Key"}}},"tags":[{"name":"agents","description":"Operations related to agents"},{"name":"conversations","description":"Operations related to conversations"},{"name":"channels","description":"Operations related to channels"},{"name":"channels.targets","description":"Operations related to channel targets"},{"name":"dashboard","description":"Operations related to system dashboard"},{"name":"events","description":"Operations related to agent events"},{"name":"greetings","description":"Operations related to conversation greetings"},{"name":"organizations","description":"Operations related to organizations"},{"name":"prompts","description":"Operations related to prompts"},{"name":"sessions","description":"Operations related to agent sessions"},{"name":"tools","description":"Operations related to tools"}],"x-speakeasy-name-override":[{"operationId":".*_list$","methodNameOverride":"list"},{"operationId":".*_create$","methodNameOverride":"create"},{"operationId":".*_update$","methodNameOverride":"update"},{"operationId":".*_delete$","methodNameOverride":"delete"},{"operationId":".*_get_by_id$","methodNameOverride":"get_by_id"},{"operationId":".*_get_by_name$","methodNameOverride":"get_by_name"}]}

package/docs/sdks/agents/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to agents
+Operations related to agent configuration. 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.
 
 ### Available Operations
 
@@ -103,13 +103,19 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.agents.create({
     name: "<value>",
-    timezone: "Antarctica/Rothera",
-    type: "<value>",
+    type: "ca_v1",
     promptId: 486589,
     customMessageId: 638424,
+    timezone: "America/New_York",
     languages: [
-      "<value>",
+      "en-US",
+      "es-US",
     ],
+    variables: {},
+    toolHeaders: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
   });
 
   // Handle the result
@@ -136,13 +142,19 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await agentsCreate(syllableSDK, {
     name: "<value>",
-    timezone: "Antarctica/Rothera",
-    type: "<value>",
+    type: "ca_v1",
     promptId: 486589,
     customMessageId: 638424,
+    timezone: "America/New_York",
     languages: [
-      "<value>",
+      "en-US",
+      "es-US",
     ],
+    variables: {},
+    toolHeaders: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
   });
 
   if (!res.ok) {
@@ -169,7 +181,7 @@ run();
 
 ### Response
 
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
+**Promise\<[components.AgentResponse](../../models/components/agentresponse.md)\>**
 
 ### Errors
 
@@ -194,13 +206,19 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.agents.update({
     name: "<value>",
-    timezone: "Europe/Tallinn",
-    type: "<value>",
+    type: "ca_v1",
     promptId: 857478,
     customMessageId: 597129,
+    timezone: "America/Chicago",
     languages: [
-      "<value>",
+      "en-US",
+      "es-US",
     ],
+    variables: {},
+    toolHeaders: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
     id: 597129,
   });
 
@@ -228,13 +246,19 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await agentsUpdate(syllableSDK, {
     name: "<value>",
-    timezone: "Europe/Tallinn",
-    type: "<value>",
+    type: "ca_v1",
     promptId: 857478,
     customMessageId: 597129,
+    timezone: "America/Chicago",
     languages: [
-      "<value>",
+      "en-US",
+      "es-US",
     ],
+    variables: {},
+    toolHeaders: {
+      "key": "<value>",
+      "key1": "<value>",
+    },
     id: 597129,
   });
 
@@ -262,7 +286,7 @@ run();
 
 ### Response
 
-**Promise\<[components.Agent](../../models/components/agent.md)\>**
+**Promise\<[components.AgentResponse](../../models/components/agentresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/channels/README.md

@@ -3,7 +3,10 @@
 
 ## Overview
 
-Operations related to channels
+Operations related to channel configuration.           A channel is an organization-level point of communication, like a phone number or a web           chat. A channel can be associated with an agent by creating a channel target linking           them.
+
+For more information:
+<https://docs.syllable.ai/Resources/Channels>
 
 ### Available Operations
 

package/docs/sdks/conversations/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to conversations
+Operations related to conversations.           A conversation is a record of messages between a user and an agent, and is composed of           one or more sessions.
 
 ### Available Operations
 

package/docs/sdks/custommessages/README.md

@@ -3,7 +3,10 @@
 
 ## Overview
 
-Operations related to custom messages
+Operations related to custom message configuration.           A custom message is a pre-configured message delivered by an agent as a greeting at the           beginning of a conversation. Multiple agents can use the same custom mesasage. A custom           message has one or more rules defined, which allow for different messages to be           dynamically selected and delivered at runtime based on the current time and either           date or day of the week.
+
+For more information:
+<https://docs.syllable.ai/Resources/CustomMessages>
 
 ### Available Operations
 

package/docs/sdks/dashboards/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to dashboards
+Operations related to dashboards. Currently the API/SDK           only supports fetching basic information about dashboards.
 
 ### Available Operations
 

package/docs/sdks/events/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to agent events
+Operations related to events. An event represents a specific occurrence           during a session. Currently the API/SDK only supports fetching logged events.
 
 ### Available Operations
 

package/docs/sdks/prompts/README.md

@@ -3,7 +3,10 @@
 
 ## Overview
 
-Operations related to prompts
+Operations related to prompts. A prompt defines the behavior of an           agent by delivering instructions to the LLM about how the agent should behave.           A prompt can be linked to one or more agents. A prompt can also be linked to tools to           allow an agent using the prompt to use them.
+
+For more information:
+<https://docs.syllable.ai/Resources/res_WritePrompt>
 
 ### Available Operations
 
@@ -78,7 +81,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponsePrompt](../../models/components/listresponseprompt.md)\>**
+**Promise\<[components.ListResponsePromptResponse](../../models/components/listresponsepromptresponse.md)\>**
 
 ### Errors
 
@@ -162,14 +165,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PromptCreate](../../models/components/promptcreate.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PromptCreateRequest](../../models/components/promptcreaterequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 
@@ -255,14 +258,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.PromptUpdate](../../models/components/promptupdate.md)                                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [components.PromptUpdateRequest](../../models/components/promptupdaterequest.md)                                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 
@@ -339,7 +342,7 @@ run();
 
 ### Response
 
-**Promise\<[components.Prompt](../../models/components/prompt.md)\>**
+**Promise\<[components.PromptResponse](../../models/components/promptresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/services/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to services
+Operations related to service configuration. A service is a collection of           tools.
 
 ### Available Operations
 

package/docs/sdks/sessionlabels/README.md

@@ -3,6 +3,8 @@
 
 ## Overview
 
+Operations related to labeling sessions with evaluations of quality and           descriptions of issues the user encountered or other details.
+
 ### Available Operations
 
 * [getById](#getbyid) - Get Label By Id
@@ -102,8 +104,8 @@ const syllableSDK = new SyllableSDK({
 async function run() {
   const result = await syllableSDK.sessionLabels.create({
     sessionId: 486589,
-    type: "<value>",
-    code: "<value>",
+    type: "auto-rating",
+    code: "BAD",
     userEmail: "<value>",
   });
 
@@ -131,8 +133,8 @@ const syllableSDK = new SyllableSDKCore({
 async function run() {
   const res = await sessionLabelsCreate(syllableSDK, {
     sessionId: 486589,
-    type: "<value>",
-    code: "<value>",
+    type: "auto-rating",
+    code: "BAD",
     userEmail: "<value>",
   });
 

package/docs/sdks/sessions/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations related to agent sessions
+Operations related to sessions. A session is a building block of a           conversation.
 
 ### Available Operations
 

package/docs/sdks/targets/README.md

@@ -3,7 +3,10 @@
 
 ## Overview
 
-Operations related to channel targets
+Operations related to channel target configuration. A channel target           links a channel to an agent, allowing users to communicate with the agent through that           channel.
+
+For more information:
+<https://docs.syllable.ai/Resources/Channels>
 
 ### Available Operations
 
@@ -150,7 +153,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ListResponseChannelTarget](../../models/components/listresponsechanneltarget.md)\>**
+**Promise\<[components.ListResponseChannelTargetResponse](../../models/components/listresponsechanneltargetresponse.md)\>**
 
 ### Errors
 
@@ -176,10 +179,10 @@ async function run() {
   const result = await syllableSDK.channels.targets.create({
     channelId: 134365,
     channelTargetCreateRequest: {
-      channelId: 486589,
       agentId: 638424,
+      channelId: 486589,
       target: "<value>",
-      targetMode: "<value>",
+      targetMode: "chat",
       fallbackTarget: "<value>",
       isTest: true,
     },
@@ -210,10 +213,10 @@ async function run() {
   const res = await channelsTargetsCreate(syllableSDK, {
     channelId: 134365,
     channelTargetCreateRequest: {
-      channelId: 486589,
       agentId: 638424,
+      channelId: 486589,
       target: "<value>",
-      targetMode: "<value>",
+      targetMode: "chat",
       fallbackTarget: "<value>",
       isTest: true,
     },
@@ -243,7 +246,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 
@@ -322,7 +325,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 
@@ -349,13 +352,13 @@ async function run() {
     channelId: 627690,
     targetId: 488852,
     channelTargetUpdateRequest: {
-      id: 857478,
-      channelId: 597129,
       agentId: 344620,
+      channelId: 597129,
       target: "<value>",
-      targetMode: "<value>",
+      targetMode: "email",
       fallbackTarget: "<value>",
       isTest: false,
+      id: 857478,
     },
   });
 
@@ -385,13 +388,13 @@ async function run() {
     channelId: 627690,
     targetId: 488852,
     channelTargetUpdateRequest: {
-      id: 857478,
-      channelId: 597129,
       agentId: 344620,
+      channelId: 597129,
       target: "<value>",
-      targetMode: "<value>",
+      targetMode: "email",
       fallbackTarget: "<value>",
       isTest: false,
+      id: 857478,
     },
   });
 
@@ -419,7 +422,7 @@ run();
 
 ### Response
 
-**Promise\<[components.ChannelTarget](../../models/components/channeltarget.md)\>**
+**Promise\<[components.ChannelTargetResponse](../../models/components/channeltargetresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/test/README.md

@@ -3,7 +3,7 @@
 
 ## Overview
 
-Operations for testing agents with live text
+Operations for testing agents with live text.           These endpoints allow sending messages to an agent and receiving its responses.
 
 ### Available Operations