{ "openapi": "3.1.0", "info": { "title": "WxO Server API", "summary": "API for the next gen watsonx Orchestrate stack", "description": "\nThe watsonx Orchestrate Server provides a set of APIs to power the watsonx Orchestrate AI assistant. This includes the following core services:\n\n* Orchestrate Assistant - a built-in AI assistant that powers the Orchestrate end-user experience.\n* Custom Assistants - a service layer for interacting with existing AI assistatns (such as those in watsonx Assistant).\n* Message Threads - a chat history and async message tracking store.\n* Document Store - manage collections of documents in nearly any format including text, pdf, html and many more.\n* Information Extraction - automatically extract clean text and images from any document in the Document Store. Also extract other useful metadata like questions answered, keywords, and named entities.\n* Embedding - generate vector embeddings for text and images in the Document Store.\n* Vector Index and Retrieval - automatically index documents with rich metadata for vector search or hybrid search.\n* Search Engine - create a Gen AI powered search engine that works like Bing or Google.\n* Query Engine - configure your own RAG (Retrieval Augmented Generation) engine supporting advanced retrieval patterns and automated data management.\n* Model Proxy - create your own LLM model endpoints for chat completions and embeddings. Supports IBM watsonx.ai, IBM BAM, OpenAI, MistralAI, or Ollama for local models.\n\nWxO API Server utilizes the following open source projects:\n\n* [PostgreSQL](https://www.postgresql.org/)\n* [PGVector](https://github.com/pgvector/pgvector)\n* [LlamaIndex](https://docs.llamaindex.ai/en/stable/)\n* [LangChain](https://python.langchain.com/docs/get_started/introduction)\n* [FastAPI](https://fastapi.tiangolo.com/)\n* [Unstructured](https://unstructured.io/)\n* [Celery](https://docs.celeryproject.org/en/stable/)\n\n", "version": "0.1.0" }, "servers": [ { "url": "https://{api_endpoint}", "description": "version" } ], "paths": { "/v1/orchestrate/runs/stream": { "post": { "tags": [ "Orchestrate Agent" ], "summary": "Chat With Orchestrate Assistant As Stream", "operationId": "Chat_with_Orchestrate_Assistant_as_Stream_v1_orchestrate_runs_stream_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "stream_timeout", "in": "query", "required": false, "schema": { "type": "integer", "default": 60000, "title": "Stream Timeout" } }, { "name": "multiple_content", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Multiple Content" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOrchestrate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunEvent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/runs": { "post": { "tags": [ "Orchestrate Agent" ], "summary": "Chat With Orchestrate Assistant", "operationId": "Chat_with_Orchestrate_Assistant_v1_orchestrate_runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "stream", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Stream" } }, { "name": "multiple_content", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Multiple Content" } }, { "name": "stream_timeout", "in": "query", "required": false, "schema": { "type": "integer", "default": 60000, "title": "Stream Timeout" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOrchestrate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Orchestrate Agent" ], "summary": "List Orchestrate Assistant Runs", "operationId": "List_Orchestrate_Assistant_Runs_v1_orchestrate_runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Limit the number of results returned", "default": 10, "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Skip the first N results", "default": 0, "title": "Offset" }, "description": "Skip the first N results" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAssistantRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/upload-to-s3/": { "post": { "tags": [ "Orchestrate Agent" ], "summary": "Upload To S3", "operationId": "upload_to_s3_v1_orchestrate_upload_to_s3__post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/fastapi___compat__v2__Body_upload_to_s3_v1_orchestrate_upload_to_s3__post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/runs/cancel/{run_id}": { "post": { "tags": [ "Orchestrate Agent" ], "summary": "Cancel An Orchestrate Assistant Run", "operationId": "Cancel_an_Orchestrate_Assistant_run_v1_orchestrate_runs_cancel__run_id__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantRunCancelResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/runs/{run_id}": { "get": { "tags": [ "Orchestrate Agent" ], "summary": "Get Orchestrate Assistant Run", "operationId": "Get_Orchestrate_Assistant_Run_v1_orchestrate_runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantRun" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/runs/{run_id}/events": { "get": { "tags": [ "Orchestrate Agent" ], "summary": "Get Orchestrate Assistant Run Events", "operationId": "Get_Orchestrate_Assistant_Run_Events_v1_orchestrate_runs__run_id__events_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "stream_timeout", "in": "query", "required": false, "schema": { "type": "integer", "default": 1000, "title": "Stream Timeout" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunEvent" }, "title": "Response Get Orchestrate Assistant Run Events V1 Orchestrate Runs Run Id Events Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/{agent_id}/chat/completions": { "post": { "tags": [ "Orchestrate Agent" ], "summary": "Chat With Agents", "operationId": "Chat_with_Agents_v1_orchestrate__agent_id__chat_completions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "X-IBM-THREAD-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional header to specify the thread ID", "title": "X-Ibm-Thread-Id" }, "description": "Optional header to specify the thread ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletion" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/{assistant_id}/runs": { "post": { "tags": [ "Assistants Runs" ], "summary": "Run Assistant", "operationId": "Run_Assistant_v1_assistants__assistant_id__runs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunOrchestrate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Assistants Runs" ], "summary": "List Assistant Runs", "operationId": "List_Assistant_Runs_v1_assistants__assistant_id__runs_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssistantRun" }, "title": "Response List Assistant Runs V1 Assistants Assistant Id Runs Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/{assistant_id}/runs/{run_id}": { "get": { "tags": [ "Assistants Runs" ], "summary": "Get Assistant Run By Id", "operationId": "Get_Assistant_Run_by_ID_v1_assistants__assistant_id__runs__run_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistantRun" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/custom": { "post": { "tags": [ "Custom Assistants" ], "summary": "Create Custom Assistant", "operationId": "Create_Custom_Assistant_v1_assistants_custom_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomAssistant" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Custom Assistants" ], "summary": "List Custom Assistants", "operationId": "List_Custom_Assistants_v1_assistants_custom_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomAssistantOut" }, "title": "Response List Custom Assistants V1 Assistants Custom Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/custom/{assistant_id}": { "patch": { "tags": [ "Custom Assistants" ], "summary": "Update Custom Assistant", "operationId": "Update_Custom_Assistant_v1_assistants_custom__assistant_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchCustomAssistant" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Custom Assistants" ], "summary": "Delete Custom Assistant", "operationId": "Delete_Custom_Assistant_v1_assistants_custom__assistant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Custom Assistants" ], "summary": "Get Custom Assistant By Id", "operationId": "Get_Custom_Assistant_by_ID_v1_assistants_custom__assistant_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomAssistantOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/custom/{assistant_id}/files": { "post": { "tags": [ "Custom Assistants" ], "summary": "Upload File To A Custom Assistant", "operationId": "Upload_File_to_a_Custom_Assistant_v1_assistants_custom__assistant_id__files_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } }, { "name": "extraction_strategy", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "express" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_File_to_a_Custom_Assistant_v1_assistants_custom__assistant_id__files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Custom Assistants" ], "summary": "List Custom Assistant Files", "operationId": "List_Custom_Assistant_Files_v1_assistants_custom__assistant_id__files_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentOut" }, "title": "Response List Custom Assistant Files V1 Assistants Custom Assistant Id Files Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/custom/{assistant_id}/files/{document_id}": { "delete": { "tags": [ "Custom Assistants" ], "summary": "Delete Custom Assistant File By Id", "operationId": "Delete_Custom_Assistant_File_by_ID_v1_assistants_custom__assistant_id__files__document_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } }, { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/watsonx": { "post": { "tags": [ "watsonx Assistant" ], "summary": "Register Watsonx Assistant Instance", "operationId": "Register_watsonx_Assistant_Instance_v1_assistants_watsonx_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterWatsonAssistant" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "watsonx Assistant" ], "summary": "List Watsonx Assistant Instances", "operationId": "List_watsonx_Assistant_Instances_v1_assistants_watsonx_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/WatsonAssistantOut" }, { "$ref": "#/components/schemas/ExternalChatAgent" } ] }, "title": "Response List Watsonx Assistant Instances V1 Assistants Watsonx Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/watsonx/{assistant_id}": { "get": { "tags": [ "watsonx Assistant" ], "summary": "Get Watsonx Assistant Instance", "operationId": "Get_watsonx_Assistant_Instance_v1_assistants_watsonx__assistant_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WatsonAssistantOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "watsonx Assistant" ], "summary": "Update Watsonx Assistant Instance", "operationId": "Update_watsonx_Assistant_Instance_v1_assistants_watsonx__assistant_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchWatsonAssistant" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "watsonx Assistant" ], "summary": "Delete Watsonx Assistant Instance", "operationId": "Delete_watsonx_Assistant_Instance_v1_assistants_watsonx__assistant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "assistant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Assistant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/assistants/watsonx/wxassistant/listfromwxa": { "get": { "tags": [ "watsonx Assistant" ], "summary": "Fetch List Of Assistants Available In Wxa Instance", "operationId": "Fetch_list_of_assistants_available_in_WxA_instance_v1_assistants_watsonx_wxassistant_listfromwxa_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "crn_details", "in": "query", "required": true, "schema": { "type": "string", "title": "Crn Details" } }, { "name": "pagination_footer", "in": "query", "required": false, "schema": { "type": "string", "title": "Pagination Footer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agents/external-chat": { "post": { "tags": [ "External Chat Agents" ], "summary": "Register An External Chat Completions Agent.", "operationId": "Register_an_external_chat_completions_agent__v1_agents_external_chat_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalChatAgent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "External Chat Agents" ], "summary": "List Registered External Chat Completions Agants.", "operationId": "List_registered_external_chat_completions_agants__v1_agents_external_chat_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalChatAgent" }, "title": "Response List Registered External Chat Completions Agants V1 Agents External Chat Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/agents/external-chat/{id}": { "get": { "tags": [ "External Chat Agents" ], "summary": "Get A Registered External Chat Completions Agent By Id.", "operationId": "Get_a_registered_external_chat_completions_agent_by_ID__v1_agents_external_chat__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalChatAgent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "External Chat Agents" ], "summary": "Update A Registered External Chat Completions Agent.", "operationId": "Update_a_registered_external_chat_completions_agent__v1_agents_external_chat__id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchExternalChatAgent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "External Chat Agents" ], "summary": "Delete A Registered External Chat Completions Agent.", "operationId": "Delete_a_registered_external_chat_completions_agent__v1_agents_external_chat__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/a2a/versions": { "get": { "tags": [ "A2A Protocol" ], "summary": "Get supported A2A protocol versions", "description": "Returns the list of supported A2A protocol versions for a specific role (client or server).\n\n - **role**: Specify 'client' or 'server' to get versions for that role\n - Returns version information including feature support matrix\n - Client role is currently implemented\n - Server role is not yet implemented", "operationId": "get_supported_versions_v1_a2a_versions_get", "parameters": [ { "name": "role", "in": "query", "required": false, "schema": { "enum": [ "client", "server" ], "type": "string", "description": "Role type: 'client' for A2A client versions, 'server' for A2A server versions", "default": "client", "title": "Role" }, "description": "Role type: 'client' for A2A client versions, 'server' for A2A server versions" } ], "responses": { "200": { "description": "Successfully retrieved A2A supported versions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/A2ASupportedVersionsResponse" } } } }, "400": { "description": "Invalid role parameter" }, "501": { "description": "A2A server role not yet implemented" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/threads": { "post": { "tags": [ "Message Threads" ], "summary": "Create Message Thread", "operationId": "Create_Message_Thread_v1_threads_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateThread" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Message Threads" ], "summary": "List Message Threads", "operationId": "List_Message_Threads_v1_threads_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Limit the number of results returned", "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Skip the first N results", "title": "Offset" }, "description": "Skip the first N results" }, { "name": "agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter threads by agent ID", "title": "Agent Id" }, "description": "Filter threads by agent ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ThreadResponseWithPagination" }, { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } } ], "title": "Response List Message Threads V1 Threads Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/threads/{thread_id}": { "get": { "tags": [ "Message Threads" ], "summary": "Get Message Thread By Id", "operationId": "Get_Message_Thread_by_ID_v1_threads__thread_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Thread" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Message Threads" ], "summary": "Update Message Thread", "operationId": "Update_Message_Thread_v1_threads__thread_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchThread" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Message Threads" ], "summary": "Delete Message Thread", "operationId": "Delete_Message_Thread_v1_threads__thread_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/threads/{thread_id}/messages": { "post": { "tags": [ "Message Threads" ], "summary": "Create Message", "operationId": "Create_Message_v1_threads__thread_id__messages_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Message Threads" ], "summary": "List Messages", "operationId": "List_Messages_v1_threads__thread_id__messages_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" }, "title": "Response List Messages V1 Threads Thread Id Messages Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/threads/{thread_id}/messages/{message_id}": { "patch": { "tags": [ "Message Threads" ], "summary": "Update Message", "operationId": "Update_Message_v1_threads__thread_id__messages__message_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchMessage" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Message Threads" ], "summary": "Delete Message", "operationId": "Delete_Message_v1_threads__thread_id__messages__message_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Message Threads" ], "summary": "Get Message By Id", "operationId": "Get_Message_by_ID_v1_threads__thread_id__messages__message_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Message Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/document-collections": { "get": { "tags": [ "Documents" ], "summary": "Fetch Document Collections", "operationId": "Fetch_Document_Collections_v1_document_collections_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentCollectionOut" }, "title": "Response Fetch Document Collections V1 Document Collections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Documents" ], "summary": "Create Document Collection", "operationId": "Create_Document_Collection_v1_document_collections_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentCollection" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "Delete Document Collections", "operationId": "Delete_Document_Collections_v1_document_collections_delete", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/document-collections/{collection_id}": { "patch": { "tags": [ "Documents" ], "summary": "Update Document Collection", "operationId": "Update_Document_Collection_v1_document_collections__collection_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCollectionPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Documents" ], "summary": "Get Document Collection By Id", "operationId": "Get_Document_Collection_by_ID_v1_document_collections__collection_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "collection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Collection Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentCollectionOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents": { "post": { "tags": [ "Documents" ], "summary": "Create Document", "operationId": "Create_Document_v1_documents_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocument" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Documents" ], "summary": "List Documents", "operationId": "List_Documents_v1_documents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentOut" }, "title": "Response List Documents V1 Documents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{doc_id}": { "patch": { "tags": [ "Documents" ], "summary": "Update Document", "operationId": "Update_Document_v1_documents__doc_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "Delete Document By Id", "operationId": "Delete_Document_by_Id_v1_documents__doc_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Documents" ], "summary": "Get Document By Id", "operationId": "Get_Document_by_ID_v1_documents__doc_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{doc_id}/upload": { "post": { "tags": [ "Documents" ], "summary": "Upload Document", "operationId": "Upload_Document_v1_documents__doc_id__upload_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } }, { "name": "extraction_strategy", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "express" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_Document_v1_documents__doc_id__upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundTaskOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/documents/{doc_id}/download": { "get": { "tags": [ "Documents" ], "summary": "Download Document", "operationId": "Download_Document_v1_documents__doc_id__download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Doc Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices": { "post": { "tags": [ "Vector Index" ], "summary": "Create Vector Index", "operationId": "Create_Vector_Index_v1_vector_indices_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVectorIndex" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Vector Index" ], "summary": "Delete Vector Index", "operationId": "Delete_Vector_Index_v1_vector_indices_delete", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "get": { "tags": [ "Vector Index" ], "summary": "List Vector Indices", "operationId": "List_Vector_Indices_v1_vector_indices_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VectorIndexOut" }, "title": "Response List Vector Indices V1 Vector Indices Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices/{index_id}": { "get": { "tags": [ "Vector Index" ], "summary": "Get Vector Index By Id", "operationId": "Get_Vector_Index_by_ID_v1_vector_indices__index_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorIndexOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Vector Index" ], "summary": "Update Vector Index", "operationId": "Update_Vector_Index_v1_vector_indices__index_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorIndexPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices/{index_id}/collections": { "get": { "tags": [ "Vector Index" ], "summary": "Get Collections In Vector Index", "operationId": "Get_Collections_in_Vector_Index_v1_vector_indices__index_id__collections_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentCollectionOut" }, "title": "Response Get Collections In Vector Index V1 Vector Indices Index Id Collections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Vector Index" ], "summary": "Add Collection To Vector Index", "operationId": "Add_Collection_to_Vector_Index_v1_vector_indices__index_id__collections_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } }, { "name": "collection_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Collection Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices/{index_id}/refresh": { "put": { "tags": [ "Vector Index" ], "summary": "Refresh Vector Index", "operationId": "Refresh_Vector_Index_v1_vector_indices__index_id__refresh_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundTask" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices/{index_id}/rebuild": { "put": { "tags": [ "Vector Index" ], "summary": "Rebuild Vector Index", "operationId": "Rebuild_Vector_Index_v1_vector_indices__index_id__rebuild_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundTask" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/vector-indices/{index_id}/retrieve": { "post": { "tags": [ "Vector Index" ], "summary": "Retrieve Documents From The Vector Index", "operationId": "Retrieve_Documents_from_the_Vector_Index_v1_vector_indices__index_id__retrieve_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "index_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Index Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/gateway/model/chat/completions": { "post": { "tags": [ "AI Gateway Passthrough" ], "summary": "Pure Passthrough To Chat Completions", "operationId": "Pure_passthrough_to_chat_completions_v1_orchestrate_gateway_model_chat_completions_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "llm_as_judge", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this request is used as LLM as a judge", "default": false, "title": "Llm As Judge" }, "description": "Whether this request is used as LLM as a judge" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/gateway/model/embeddings": { "post": { "tags": [ "AI Gateway Passthrough" ], "summary": "Pure Passthrough To Embeddings", "operationId": "Pure_passthrough_to_embeddings_v1_orchestrate_gateway_model_embeddings_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Body" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/catalog/export": { "post": { "tags": [ "Catalog Management" ], "summary": "Export Catalog Resources", "operationId": "Export_Catalog_resources_v1_catalog_export_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogExportRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogExport" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/catalog/applications": { "get": { "tags": [ "Catalog Management" ], "summary": "List All Apps Available In Catalog", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "List_all_Apps_available_in_Catalog_v1_catalog_applications_get", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 255 }, { "type": "null" } ], "title": "Search" } }, { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortType", "default": "ASC" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_ArtifactGroup_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/catalog/applications/{catalog_ref_id}/skill": { "get": { "tags": [ "Catalog Management" ], "summary": "List All Skills Available From Catalog, Under An Application", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "List_all_skills_available_from_Catalog__under_an_Application_v1_catalog_applications__catalog_ref_id__skill_get", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "catalog_ref_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Catalog Ref Id" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 50 }, { "type": "null" } ], "title": "Search" } }, { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortType", "default": "ASC" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_CatalogSkillResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tenants": { "get": { "tags": [ "Tenant Management" ], "summary": "Fetch Tenants", "operationId": "Fetch_Tenants_v1_tenants_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenantOut" }, "title": "Response Fetch Tenants V1 Tenants Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Tenant Management" ], "summary": "Create Tenant", "operationId": "Create_Tenant_v1_tenants_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenant" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tenants/{tenant_id}": { "patch": { "tags": [ "Tenant Management" ], "summary": "Update Tenant", "operationId": "Update_Tenant_v1_tenants__tenant_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantPatch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Tenant Management" ], "summary": "Delete Tenant By Id", "operationId": "Delete_Tenant_by_ID_v1_tenants__tenant_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Tenant Management" ], "summary": "Get Tenant By Id", "operationId": "Get_Tenant_by_ID_v1_tenants__tenant_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tenants/{tenant_id}/permissions": { "put": { "tags": [ "Tenant Management" ], "summary": "Sync Tenant Permission", "operationId": "Sync_Tenant_Permission_v1_tenants__tenant_id__permissions_put", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "user_id", "in": "query", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "permission", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TenantPermission" }, { "type": "null" } ], "title": "Permission" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tenants/{tenant_id}/permissions/{user_id}": { "delete": { "tags": [ "Tenant Management" ], "summary": "Revoke Tenant Permissions", "operationId": "Revoke_Tenant_Permissions_v1_tenants__tenant_id__permissions__user_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/provision": { "post": { "tags": [ "Provisioning Lite" ], "summary": "Provision", "operationId": "provision_v1_lite_provision_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantProvisionPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Provisioning Lite" ], "summary": "Deprovision", "operationId": "deprovision_v1_lite_provision_delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantProvisionPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/grant": { "post": { "tags": [ "Provisioning Lite" ], "summary": "Add User", "operationId": "add_user_v1_lite_grant_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/revoke": { "delete": { "tags": [ "Provisioning Lite" ], "summary": "Delete User", "operationId": "delete_user_v1_lite_revoke_delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/serviceInstance/users/role": { "patch": { "tags": [ "Provisioning Lite" ], "summary": "Update User", "operationId": "update_user_v1_lite_serviceInstance_users_role_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/monitorServiceInstance": { "post": { "tags": [ "Provisioning Lite" ], "summary": "Monitor Instance", "operationId": "monitor_instance_v1_lite_monitorServiceInstance_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantProvisionPayload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/lite/tenantAndUserEvents": { "post": { "tags": [ "Provisioning Lite" ], "summary": "Propagate Tenant And User Events", "operationId": "propagate_tenant_and_user_events_v1_lite_tenantAndUserEvents_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/lite/rebroadcast": { "post": { "tags": [ "Provisioning Lite" ], "summary": "Rebroadcast", "operationId": "rebroadcast_v1_lite_rebroadcast_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/private/embed/config": { "get": { "tags": [ "Embed settings" ], "summary": "Get Config", "operationId": "Get_config_v1_private_embed_config_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsOut" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "Embed settings" ], "summary": "Create Config", "operationId": "Create_Config_v1_private_embed_config_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsInput" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/private/embed/generate-key-pair": { "post": { "tags": [ "Embed settings" ], "summary": "Generate Key Pair", "operationId": "Generate_key_pair_v1_private_embed_generate_key_pair_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyPairOut" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/profiles/me": { "get": { "tags": [ "User Profiles" ], "summary": "Get My Profile", "operationId": "get_my_profile_v1_profiles_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileOut" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/profiles/me/settings": { "patch": { "tags": [ "User Profiles" ], "summary": "Update Profile Settings", "operationId": "update_profile_settings_v1_profiles_me_settings_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchUserProfile" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/completions": { "post": { "tags": [ "Completions" ], "summary": "Create Completion", "operationId": "Create_Completion_v1_completions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/completions/chat": { "post": { "tags": [ "Completions" ], "summary": "Create Chat Completion", "operationId": "Create_Chat_Completion_v1_completions_chat_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatCompletionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/tasks": { "get": { "tags": [ "Background Tasks" ], "summary": "List Background Tasks", "operationId": "List_Background_Tasks_v1_tasks_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BackgroundTaskOut" }, "type": "array", "title": "Response List Background Tasks V1 Tasks Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/tasks/{task_id}": { "get": { "tags": [ "Background Tasks" ], "summary": "Fetch Background Task", "operationId": "Fetch_Background_Task_v1_tasks__task_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundTaskOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tasks/{task_id}/abort": { "put": { "tags": [ "Background Tasks" ], "summary": "Abort Background Task", "operationId": "Abort_Background_Task_v1_tasks__task_id__abort_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/auth/register-user": { "post": { "tags": [ "Auth" ], "summary": "Register A User Profile", "operationId": "Register_a_User_Profile_v1_auth_register_user_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterUser" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/auth/token": { "post": { "tags": [ "Auth" ], "summary": "Login For Token", "operationId": "Login_for_Token_v1_auth_token_post", "parameters": [ { "name": "tenant_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/Body_Login_for_Token_v1_auth_token_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Token" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/callback/{thread_id}": { "post": { "tags": [ "Orchestrate Assistant" ], "summary": "Callback", "operationId": "callback_v1_callback__thread_id__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessage" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/notifications/": { "post": { "tags": [ "Notifications" ], "summary": "Post A Notification", "operationId": "Post_a_notification_v1_notifications__post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNotification" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/notifications": { "get": { "tags": [ "Notifications" ], "summary": "Fetch All Notifications For A User By Tenant", "operationId": "Fetch_all_notifications_for_a_user_by_tenant_v1_notifications_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "select", "in": "query", "required": false, "schema": { "type": "string", "default": "*", "title": "Select" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationOut" }, "title": "Response Fetch All Notifications For A User By Tenant V1 Notifications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/notifications/{thread_id}": { "delete": { "tags": [ "Notifications" ], "summary": "Post A Notification", "operationId": "Post_a_notification_v1_notifications__thread_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/unique-id-mapping": { "post": { "tags": [ "IBM unique ID mapping" ], "summary": "Create Tenant Unique Id Mapping", "operationId": "Create_Tenant_Unique_ID_mapping_v1_unique_id_mapping_post", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "get": { "tags": [ "IBM unique ID mapping" ], "summary": "Get Unique Id Mapping", "operationId": "get_unique_Id_mapping_v1_unique_id_mapping_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "IBM unique ID mapping" ], "summary": "Delete Mapping", "operationId": "Delete_Mapping_v1_unique_id_mapping_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "tenant_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Tenant Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/default_user_prompts": { "get": { "tags": [ "Prompts" ], "summary": "Get Prompts", "operationId": "Get_Prompts_v1_default_user_prompts_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PromptOut" }, "type": "array", "title": "Response Get Prompts V1 Default User Prompts Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "put": { "tags": [ "Prompts" ], "summary": "Create Or Update Prompt", "operationId": "Create_or_Update_Prompt_v1_default_user_prompts_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptsList" } } }, "required": true }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PromptOut" }, "type": "array", "title": "Response Create Or Update Prompt V1 Default User Prompts Put" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "delete": { "tags": [ "Prompts" ], "summary": "Delete All Prompts", "operationId": "Delete_all_Prompts_v1_default_user_prompts_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/default_user_prompts/{id}": { "delete": { "tags": [ "Prompts" ], "summary": "Delete Prompt", "operationId": "Delete_Prompt_v1_default_user_prompts__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Prompts" ], "summary": "Get A Prompt", "operationId": "Get_a_Prompt_v1_default_user_prompts__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromptOut" }, "title": "Response Get A Prompt V1 Default User Prompts Id Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/applications/": { "get": { "tags": [ "Artifact Management" ], "summary": "Fetch List Of Apps Added In Archer", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Fetch_List_of_Apps_Added_in_Archer_v1_applications__get", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "show_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "ge": 0, "default": false, "title": "Show Hidden" } }, { "name": "group_by", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ArtifactGroupIdentifier" }, { "type": "null" } ], "title": "Group By" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AppDetailsResponseModel" } }, { "type": "array", "items": { "$ref": "#/components/schemas/GroupedArtifactResponse" } } ], "title": "Response Fetch List Of Apps Added In Archer V1 Applications Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/applications/skills": { "get": { "tags": [ "Artifact Management" ], "summary": "Fetch List Of Skills Added In Archer", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Fetch_List_of_Skills_added_in_Archer_v1_applications_skills_get", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 10, "title": "Limit" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 50 }, { "type": "null" } ], "title": "Search" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse_SkillResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Artifact Management" ], "summary": "Add Skill To Archer", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Add_Skill_to_Archer_v1_applications_skills_post", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSkillRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/applications/{artifact_group_id}/skills/{artifact_id}": { "patch": { "tags": [ "Artifact Management" ], "summary": "Edit Skill : Update Routing-Description", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Edit_Skill___Update_routing_description_v1_applications__artifact_group_id__skills__artifact_id__patch", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Group Id" } }, { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRoutingDescriptionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/applications/{artifact_group_id}/skill/{artifact_id}": { "delete": { "tags": [ "Artifact Management" ], "summary": "Remove Skill From Archer", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Remove_skill_from_archer_v1_applications__artifact_group_id__skill__artifact_id__delete", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "artifact_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Id" } }, { "name": "artifact_group_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Artifact Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/applications/{catalog_ref_id}": { "patch": { "tags": [ "Artifact Management" ], "summary": "Update Skill In Archer", "description": "This operation will no longer be available after 2025-04-30 and will be discontinued in upcoming weeks due to the deprecation of the direct use of apps and skills in the AI agent. Use tools to complete specific tasks through agents.", "operationId": "Update_skill_in_archer_v1_applications__catalog_ref_id__patch", "deprecated": true, "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "catalog_ref_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Catalog Ref Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditAppRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/journeys": { "get": { "tags": [ "all journey types" ], "summary": "List All Possible Journeys", "operationId": "list_all_possible_journeys_v1_journeys_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/JourneyRepresentation" }, "type": "array", "title": "Response List All Possible Journeys V1 Journeys Get" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/connections/applications": { "get": { "tags": [ "Connections" ], "summary": "Get Connections", "description": "Retrieve a connection based on the provided app ID and shared flag.\n\nArgs:\n current_user (UserProfile): The currently authenticated user.\n session (Session): Database session dependency.\n appid (str): The application ID for the connection.\n shared (bool): Indicates if the connection is shared.\n\nReturns:\n dict: The connection details, excluding sensitive fields.\n\nRaises:\n HTTPException: If the connection cannot be found or processed.", "operationId": "Get_Connections_v1_connections_applications_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ConnectionOut" }, "type": "array", "title": "Response Get Connections V1 Connections Applications Get" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "Connections" ], "summary": "Create Connection", "description": "Creates a new connection with validation, duplicate checking, and OAuth2 processing.\n\nArgs:\n current_user: Authenticated user profile\n session: Database session\n connection_data: Connection creation data\n\nReturns:\n dict: Status message with connection ID or OAuth2 redirect URL\n\nRaises:\n HTTPException: If connection already exists or validation fails", "operationId": "Create_Connection_v1_connections_applications_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnection", "properties": { "appid": { "type": "string", "description": "Application ID for the connection." }, "connection_type": { "type": "string", "enum": [ "basic_auth", "bearer_token", "api_key_auth", "oauth2_auth_code", "oauth2_implicit", "oauth2_password", "oauth2_client_creds", "key_value_creds" ], "description": "Type of connection. Must match one of the supported authentication methods." }, "credentials": { "properties": { "username": { "type": "string", "description": "Username for basic authentication." }, "password": { "type": "string", "description": "Password for basic authentication." }, "api_key": { "type": "string", "description": "API key for API key authentication." }, "client_id": { "type": "string", "description": "Client ID for OAuth2 flows." }, "client_secret": { "type": "string", "description": "Client Secret for OAuth2 flows." }, "well_known_url": { "type": "string", "format": "uri", "description": "URL for OAuth2 discovery." }, "scope": { "type": "string", "description": "Optional scope for OAuth2. Defaults to `openid` if not provided." } }, "type": "object", "required": [ "client_id", "client_secret", "well_known_url" ], "description": "Authentication credentials for the connection." }, "shared": { "type": "boolean", "description": "Whether the connection is shared. Defaults to `true`.", "default": true } }, "type": "object", "required": [ "appid", "connection_type", "credentials", "shared" ] }, "examples": { "basic_auth": { "description": "Basic authentication example.", "value": { "appid": "my-app-id", "connection_type": "basic_auth", "credentials": { "username": "my-username", "password": "my-password" }, "shared": true } }, "bearer_token": { "description": "Bearer token authentication example.", "value": { "appid": "my-app-id", "connection_type": "bearer_token", "credentials": { "token": "my-bearer-token" }, "shared": true } }, "api_key_auth": { "description": "API key authentication example.", "value": { "appid": "my-app-id", "connection_type": "api_key_auth", "credentials": { "api_key": "my-api-key" }, "shared": true } }, "oauth2_auth_code": { "description": "OAuth2 Authorization Code flow example.", "value": { "appid": "my-app-id", "connection_type": "oauth2_auth_code", "credentials": { "client_id": "my-client-id", "client_secret": "my-client-secret", "well_known_url": "https://example.com/.well-known/openid-configuration", "scope": "profile email openid" }, "shared": true } }, "oauth2_implicit": { "description": "OAuth2 Implicit flow example.", "value": { "appid": "my-app-id", "connection_type": "oauth2_implicit", "credentials": { "client_id": "my-client-id", "well_known_url": "https://example.com/.well-known/openid-configuration", "scope": "profile email openid" }, "shared": true } }, "oauth2_password": { "description": "OAuth2 Password Grant flow example.", "value": { "appid": "my-app-id", "connection_type": "oauth2_password", "credentials": { "client_id": "my-client-id", "client_secret": "my-client-secret", "username": "user@example.com", "password": "user-password", "well_known_url": "https://example.com/.well-known/openid-configuration", "scope": "profile email openid" }, "shared": true } }, "oauth2_client_creds": { "description": "OAuth2 Client Credentials flow example with default `openid` scope.", "value": { "appid": "my-app-id", "connection_type": "oauth2_client_creds", "credentials": { "client_id": "my-client-id", "client_secret": "my-client-secret", "well_known_url": "https://example.com/.well-known/openid-configuration", "scope": "openid" }, "shared": true } }, "key_value_creds": { "description": "Key value authentication example.", "value": { "appid": "my-app-id", "connection_type": "key_value_creds", "credentials": { "key": "value" }, "shared": true } } } } }, "required": true }, "responses": { "200": { "description": "Connection created successfully.", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Connection created successfully." }, "connection_id": { "type": "string", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "additionalProperties": true, "type": "object", "title": "Response Create Connection V1 Connections Applications Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "409": { "description": "Conflict: Connection already exists." }, "400": { "description": "Bad Request: Invalid input." } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/connections/applications/{connection_id}": { "delete": { "tags": [ "Connections" ], "summary": "Delete Connection", "operationId": "Delete_Connection_v1_connections_applications__connection_id__delete", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Id" } } ], "responses": { "200": { "description": "Connection deleted successfully", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Delete Connection V1 Connections Applications Connection Id Delete", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "connection_id": { "type": "string" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "404": { "description": "Connection not found" }, "500": { "description": "Unexpected error occurred" } } } }, "/v1/connections/callback": { "get": { "tags": [ "Connections" ], "summary": "Oauth Callback", "operationId": "oauth_callback_v1_connections_callback_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/v1/connections/applications/list": { "get": { "tags": [ "Connections" ], "summary": "Get List Of Connections", "description": "Retrieve a connection based on the provided app ID.\n\nArgs:\n current_user (UserProfile): The currently authenticated user.\n session (Session): Database session dependency.\n app_ids (str): The application IDs for the connection.\n\nReturns:\n list: The connection details\n\nRaises:\n HTTPException: If the connection cannot be found or processed.", "operationId": "Get_List_of_Connections_v1_connections_applications_list_get", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "app_ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "title": "App Ids" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": {}, "title": "Response Get List Of Connections V1 Connections Applications List Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "404": { "description": "Connection not found" }, "500": { "description": "Unexpected error occurred" } } } }, "/v1/tools": { "post": { "tags": [ "Tools" ], "summary": "Create A Tool", "operationId": "Create_a_Tool_v1_tools_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTool" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create A Tool V1 Tools Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Tools" ], "summary": "Fetch Tools", "operationId": "Fetch_Tools_v1_tools_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolOut" }, "title": "Response Fetch Tools V1 Tools Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{id}": { "put": { "tags": [ "Tools" ], "summary": "Patch A Tool", "operationId": "Patch_a_Tool_v1_tools__id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTool" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Tools" ], "summary": "Get Tool By Id", "operationId": "Get_Tool_by_id_v1_tools__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete A Tool By Id", "operationId": "Delete_a_Tool_by_id_v1_tools__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{id}/upload": { "post": { "tags": [ "Tools" ], "summary": "Upload Tools Supporting Artifact", "operationId": "Upload_tools_supporting_artifact_v1_tools__id__upload_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_tools_supporting_artifact_v1_tools__id__upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{id}/download": { "get": { "tags": [ "Tools" ], "summary": "Download Tools Supporting Artifact", "operationId": "Download_tools_supporting_artifact_v1_tools__id__download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "environment_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Environment ID, defaults to 'draft'", "default": "draft", "title": "Environment Id" }, "description": "Environment ID, defaults to 'draft'" } ], "responses": { "200": { "description": "File download", "content": { "application/json": { "schema": {} }, "application/zip": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/create-from-template": { "post": { "tags": [ "Tools" ], "summary": "Create From Template", "operationId": "Create_from_template_v1_tools_create_from_template_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "parent_agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" }, { "type": "null" } ], "title": "Parent Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateToolFromTemplate" }, "title": "Create Tool" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{tenant_id}/callback/{correlation_id}": { "post": { "tags": [ "Tools" ], "summary": "Post Tool Response From The Async Tool", "operationId": "Post_tool_response_from_the_async_tool_v1_tools__tenant_id__callback__correlation_id__post", "parameters": [ { "name": "correlation_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Correlation Id" } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Tenant Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Data" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/tools/{tenant_id}/callback/{original_correlation_id}/correlation_objects": { "post": { "tags": [ "Tools" ], "summary": "Search For Sub Correlation Object And Create If It Does Not Exists", "operationId": "Search_for_sub_correlation_object_and_create_if_it_does_not_exists_v1_tools__tenant_id__callback__original_correlation_id__correlation_objects_post", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Tenant Id" } }, { "name": "original_correlation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Original Correlation Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCorrelationObject" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/tools": { "get": { "tags": [ "Tools V2" ], "summary": "Fetch Tools", "operationId": "Fetch_Tools_v2_tools_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "toolkit_ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Toolkit Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search by name and description", "title": "Query" }, "description": "Search by name and description" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Limit the number of results returned", "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Skip the first N results", "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/wo_archer__schema__tools__SortOptions" }, { "type": "null" } ], "description": "Sort by name and recently added (recent/asc/desc)", "default": "asc", "title": "Sort" }, "description": "Sort by name and recently added (recent/asc/desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolsResponseWithPagination" }, { "type": "array", "items": { "$ref": "#/components/schemas/ToolOut" } } ], "title": "Response Fetch Tools V2 Tools Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/analytics/llm": { "get": { "tags": [ "LLM Analytics" ], "summary": "Get Llm Analytics Config", "description": "Get LLM analytics tool integration status", "operationId": "get_llm_analytics_config_v1_analytics_llm_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMAnalyticsGetResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "put": { "tags": [ "LLM Analytics" ], "summary": "Create Or Update Llm Analytics Config", "description": "Create or update LLM analytics tool integration", "operationId": "create_or_update_llm_analytics_config_v1_analytics_llm_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMAnalyticsIntegrationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMAnalyticsSuccessResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] }, "delete": { "tags": [ "LLM Analytics" ], "summary": "Delete Llm Analytics Config", "description": "Delete LLM analytics tool integration", "operationId": "delete_llm_analytics_config_v1_analytics_llm_delete", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LLMAnalyticsSuccessResponse" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/agents": { "post": { "tags": [ "Agents" ], "summary": "Register A New Agent", "description": "Registers a new agent in the system.\n\nAuthorization:\n- For IBM Cloud: Uses PDP (Policy Decision Point) authorization via check_pdp_authorization_with_session\n- For other platforms: Uses tenant-level permission check via verify_agent_access", "operationId": "Register_a_new_agent__v1_orchestrate_agents_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseCreateAgent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agents" ], "summary": "List Registered Agents", "description": "Lists all registered agents.\n\nQuery Parameters:\n include: List of additional scopes to include. Supported values:\n - 'global': Include agents from global workspace along with the specified workspace", "operationId": "List_registered_agents__v1_orchestrate_agents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } }, { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "description": "Filter agents by workspace ID. If not provided, returns agents from global workspace (workspace_id is null)", "default": "00000000-0000-0000-0000-000000000001", "title": "Workspace Id" }, "description": "Filter agents by workspace ID. If not provided, returns agents from global workspace (workspace_id is null)" }, { "name": "include", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Include additional workspace scopes. Use 'global' to include global workspace agents along with workspace-specific agents", "title": "Include" }, "description": "Include additional workspace scopes. Use 'global' to include global workspace agents along with workspace-specific agents" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ListAgent" } }, { "type": "array", "items": { "$ref": "#/components/schemas/ListAgentVersion" } } ], "title": "Response List Registered Agents V1 Orchestrate Agents Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}": { "get": { "tags": [ "Agents" ], "summary": "Get A Registered Agent By Id.", "description": "Retrieves details of a specific agent by its id.", "operationId": "Get_a_registered_agent_by_id__v1_orchestrate_agents__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAgent" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Agents" ], "summary": "Update A Registered Agent", "description": "Updates an existing agent by id.", "operationId": "Update_a_registered_agent__v1_orchestrate_agents__id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchAgent" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agents" ], "summary": "Delete A Registered Agent.", "description": "Deletes a registered agent by id.\n\n \nThe knowledge-bases in general are sharable among agents, however in UI, this is not aparent.\nProviding this flag keep_knowledge_bases for UI to set to false, in order to avoid \"orphan\" knowledge bases", "operationId": "Delete_a_registered_agent__v1_orchestrate_agents__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "keep_knowledge_bases", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Keep Knowledge Bases" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/tools-by-version": { "get": { "tags": [ "Agents" ], "summary": "Get List Of Tools Of An Agent Specific To A Version", "description": "Retrieves details of a specific agent by its id.", "operationId": "Get_list_of_tools_of_an_agent_specific_to_a_version_v1_orchestrate_agents__id__tools_by_version_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "version_label", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Version of the agent to retrieve the associated tools ", "default": 1, "title": "Version Label" }, "description": "Version of the agent to retrieve the associated tools " } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentToolVersionMinimal" }, "title": "Response Get List Of Tools Of An Agent Specific To A Version V1 Orchestrate Agents Id Tools By Version Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/template-status": { "get": { "tags": [ "Agents" ], "summary": "Get Template Creation Status", "description": "Get the creation status for an agent and its components.", "operationId": "Get_template_creation_status_v1_orchestrate_agents__id__template_status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/create-from-template": { "post": { "tags": [ "Agents" ], "summary": "Create An Agent From A Template.", "description": "Creates a new agent and its dependencies from a template.", "operationId": "Create_an_agent_from_a_template__v1_orchestrate_agents_create_from_template_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "parent_agent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" }, { "type": "null" } ], "title": "Parent Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAgentFromTemplate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/connections": { "get": { "tags": [ "Agents" ], "summary": "Get List Of Connections From All Tools Associated With An Agent", "description": "The api will traverse through all tools, tool-flows and its dependencies of the given agent and its collaborators. By default the traversal works in a multithreaded parallel execution logic, if the 'parallel_execution' flag is set to false, it executes sequentially traversing through each tool.", "operationId": "Get_List_of_Connections_from_all_tools_associated_with_an_Agent_v1_orchestrate_agents__agent_id__connections_get", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "parallel_execution", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Parallel Execution" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": {}, "title": "Response Get List Of Connections From All Tools Associated With An Agent V1 Orchestrate Agents Agent Id Connections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "404": { "description": "Agent not found" }, "500": { "description": "Unexpected error occurred" } } } }, "/v1/orchestrate/agents/{agent_id}/tools/connections": { "get": { "tags": [ "Agents" ], "summary": "Get List Of Connections From All Tools Associated With An Agent", "description": "The api will traverse through all tools, tool-flows and its dependencies of the given agent and its collaborators. By default the traversal works in a multithreaded parallel execution logic, if the 'parallel_execution' flag is set to false, it executes sequentially traversing through each tool.", "operationId": "Get_List_of_Connections_from_all_tools_associated_with_an_Agent_v1_orchestrate_agents__agent_id__tools_connections_get", "security": [ { "HTTPBearer": [] }, { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "parallel_execution", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Parallel Execution" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": {}, "title": "Response Get List Of Connections From All Tools Associated With An Agent V1 Orchestrate Agents Agent Id Tools Connections Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "404": { "description": "Agent not found" }, "500": { "description": "Unexpected error occurred" } } } }, "/v2/orchestrate/agents": { "get": { "tags": [ "Agents V2" ], "summary": "List Registered Agents.", "description": "Lists all registered agents.", "operationId": "List_registered_agents__v2_orchestrate_agents_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search by name and description", "title": "Query" }, "description": "Search by name and description" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Limit the number of results returned", "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Skip the first N results", "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/wo_archer__schema__agents__SortOptions" }, { "type": "null" } ], "description": "Sort by name and recently added (recent/asc/desc)", "default": "asc", "title": "Sort" }, "description": "Sort by name and recently added (recent/asc/desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/orchestrate/agents/unified": { "get": { "tags": [ "Agents V2" ], "summary": "List Unified Agents.", "description": "Lists all registered agents.", "operationId": "List_unified_agents__v2_orchestrate_agents_unified_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } }, { "name": "exclude_parent_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Exclude Parent Id" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search by name and description", "title": "Query" }, "description": "Search by name and description" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Limit the number of results returned", "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Skip the first N results", "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/wo_archer__schema__agents__SortOptions" }, { "type": "null" } ], "description": "Sort by name and recently added (recent/asc/desc)", "default": "asc", "title": "Sort" }, "description": "Sort by name and recently added (recent/asc/desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/environment/{environment_name}/releases": { "get": { "tags": [ "Agent Releases" ], "summary": "List Versioned Agents By Environment Name", "description": "Lists all registered agents.", "operationId": "List_versioned_agents_by_environment_name_v1_orchestrate_agents_environment__environment_name__releases_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "environment_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Name" } }, { "name": "include_hidden", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Hidden" } }, { "name": "show_bundled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Show Bundled" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListAgentVersion" }, "title": "Response List Versioned Agents By Environment Name V1 Orchestrate Agents Environment Environment Name Releases Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/releases": { "post": { "tags": [ "Agent Releases" ], "summary": "Release An Agent By Id", "description": "Release an agent by id.", "operationId": "Release_an_agent_by_id_v1_orchestrate_agents__id__releases_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ReleaseAgentIN" }, { "type": "null" } ], "title": "Req Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agent Releases" ], "summary": "Get List Of Agent Versions By Id.", "description": "Lists all agent versions by agentid.", "operationId": "Get_list_of_agent_versions_by_id__v1_orchestrate_agents__id__releases_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListAgentVersion" }, "title": "Response Get List Of Agent Versions By Id V1 Orchestrate Agents Id Releases Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/releases/status": { "get": { "tags": [ "Agent Releases" ], "summary": "Get The Status Of The Agent Deployment", "description": "Get status of the current deployed agent version.", "operationId": "Get_the_status_of_the_agent_deployment_v1_orchestrate_agents__id__releases_status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "environment_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/releases/{version}": { "get": { "tags": [ "Agent Releases" ], "summary": "Get An Agent Version By Id And Version", "description": "Get an agent version by id and version.", "operationId": "Get_an_agent_version_by_id_and_version_v1_orchestrate_agents__id__releases__version__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentVersion" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agent Releases" ], "summary": "Delete Version Of A Released Agent", "description": "Delete version of a released agent by id and version.", "operationId": "Delete_version_of_a_released_agent_v1_orchestrate_agents__id__releases__version__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/releases/{version}/undeploy": { "post": { "tags": [ "Agent Releases" ], "summary": "Undeploy A Released Agent", "description": "Undeploy a released agent by id and version.", "operationId": "Undeploy_a_released_agent_v1_orchestrate_agents__id__releases__version__undeploy_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/releases/{version}/environment/{env_id}": { "post": { "tags": [ "Agent Releases" ], "summary": "Switch Current Agent Version Of An Environment To A New Version.", "description": "Switch current agent version of an environment to a new version.", "operationId": "Switch_current_agent_version_of_an_environment_to_a_new_version__v1_orchestrate_agents__id__releases__version__environment__env_id__post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "env_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Env Id" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer", "title": "Version" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environment": { "post": { "tags": [ "Agent Release Environments" ], "summary": "Create An Environment For An Agent", "description": "Registers a new environment for an agent.", "operationId": "Create_an_environment_for_an_agent_v1_orchestrate_agents__agent_id__environment_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEnvironment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agent Release Environments" ], "summary": "List All Environments Of An Agent", "description": "List all environments of an agent.", "operationId": "List_all_environments_of_an_agent_v1_orchestrate_agents__agent_id__environment_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Environment" }, "title": "Response List All Environments Of An Agent V1 Orchestrate Agents Agent Id Environment Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environment/{environment_id}": { "get": { "tags": [ "Agent Release Environments" ], "summary": "Get A Specific Environment For An Agent", "description": "Get a specific environment for an agent.", "operationId": "Get_a_specific_environment_for_an_agent_v1_orchestrate_agents__agent_id__environment__environment_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Agent Release Environments" ], "summary": "Update An Environment Of An Agent By Id", "description": "Update an environment of an agent by id.", "operationId": "Update_an_environment_of_an_agent_by_id_v1_orchestrate_agents__agent_id__environment__environment_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchEnvironment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agent Release Environments" ], "summary": "Delete An Environment Of An Agent By Id", "description": "Delete an environment of an agent by id.", "operationId": "Delete_an_environment_of_an_agent_by_id_v1_orchestrate_agents__agent_id__environment__environment_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/chat-starter-settings": { "put": { "tags": [ "Agent Chat Starter Settings" ], "summary": "Create Or Update Chat Starter Settings For A Registered Agent", "description": "Create or update chat starter settings for a registered agent.", "operationId": "Create_or_update_chat_starter_settings_for_a_registered_agent_v1_orchestrate_agents__id__chat_starter_settings_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentChatStarterSettingsIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agent Chat Starter Settings" ], "summary": "Get Chat Starter Settings For A Registered Agent", "description": "Retrieves welcome message and starter prompts of a specific agent by its id.", "operationId": "Get_Chat_Starter_Settings_for_a_registered_agent_v1_orchestrate_agents__id__chat_starter_settings_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "environment_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" } }, { "name": "version_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentChatStarterSettingsOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Agent Chat Starter Settings" ], "summary": "Delete Chat Starter Settings", "operationId": "Delete_Chat_Starter_Settings_v1_orchestrate_agents__id__chat_starter_settings_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } }, { "name": "setting_type", "in": "query", "required": true, "schema": { "type": "string", "description": "Type of chat starter setting to delete. Can only accept 'starter_prompts', 'welcome_content', 'icon' or 'all'.", "title": "Setting Type" }, "description": "Type of chat starter setting to delete. Can only accept 'starter_prompts', 'welcome_content', 'icon' or 'all'." }, { "name": "prompt_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{id}/chat-starter-settings/icon": { "put": { "tags": [ "Agent Chat Starter Settings" ], "summary": "Create Or Update Icon For Agent", "description": "Upload the icon for a registerd agent.", "operationId": "Create_or_update_icon_for_agent_v1_orchestrate_agents__id__chat_starter_settings_icon_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Create_or_update_icon_for_agent_v1_orchestrate_agents__id__chat_starter_settings_icon_put" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/health/alive": { "get": { "summary": "Alive", "description": "Get liveness status of the server. We are always assuming alive because of reconnection strategies", "operationId": "alive_v1_health_alive_get", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {} } } } } } }, "/v1/health/ready": { "get": { "summary": "Ready", "description": "Get server readiness to accept traffic", "operationId": "ready_v1_health_ready_get", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": {} } } }, "503": { "description": "Service is not healthy" } } } }, "/v1/integration/slack/app": { "get": { "tags": [ "channel integration" ], "summary": "List App", "operationId": "list_app_v1_integration_slack_app_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "channel integration" ], "summary": "Register App", "operationId": "register_app_v1_integration_slack_app_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSlackApp" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/integration/slack/app/{id}": { "delete": { "tags": [ "channel integration" ], "summary": "Delete App", "operationId": "delete_app_v1_integration_slack_app__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/integration/slack": { "get": { "tags": [ "channel integration" ], "summary": "List Slack App Instance", "operationId": "List_Slack_app_instance_v1_integration_slack_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] }, "post": { "tags": [ "channel integration" ], "summary": "Register Slack App Instance", "operationId": "Register_Slack_app_instance_v1_integration_slack_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlackAppInstanceCallBack" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/integration/slack/{id}": { "get": { "tags": [ "channel integration" ], "summary": "Get Slack App Instance By Id", "operationId": "Get_Slack_app_instance_by_id_v1_integration_slack__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "channel integration" ], "summary": "Delete Slack App Instance By Id", "operationId": "delete_Slack_app_instance_by_id_v1_integration_slack__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/integration/slack/{app_id}/{tenant_id}/{environment_id}/message": { "post": { "tags": [ "channel integration" ], "summary": "Call Slack App Instance", "operationId": "call_slack_app_instance_v1_integration_slack__app_id___tenant_id___environment_id__message_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string", "title": "App Id" } }, { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Tenant Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/knowledge-bases/documents": { "post": { "tags": [ "Knowledge-Bases" ], "summary": "Create A Knowledge-Base By Uploading Documents, Or Providing An External Vector Index", "operationId": "Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases_documents_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases_documents_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/knowledge-bases/{kb_id}/documents": { "patch": { "tags": [ "Knowledge-Bases" ], "summary": "Patch A Knowledge-Base By Uploading Documents, Or Providing An External Vector Index", "operationId": "Patch_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases__kb_id__documents_patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Kb Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Patch_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases__kb_id__documents_patch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Knowledge-Bases" ], "summary": "Ingest Additional Documents Into A Knowledge-Base", "operationId": "Ingest_additional_documents_into_a_knowledge_base_v1_orchestrate_knowledge_bases__kb_id__documents_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Kb Id" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Ingest_additional_documents_into_a_knowledge_base_v1_orchestrate_knowledge_bases__kb_id__documents_put" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/knowledge-bases/{id}": { "delete": { "tags": [ "Knowledge-Bases" ], "summary": "Delete A Kb And Ingested Documents By Id", "operationId": "Delete_a_KB_and_ingested_documents_by_id_v1_orchestrate_knowledge_bases__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Knowledge-Bases" ], "summary": "Get A Kb By Id.", "description": "Retrieves details of a specific agent by its id.", "operationId": "Get_a_KB_by_id__v1_orchestrate_knowledge_bases__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListKnowledgeBase" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/knowledge-bases/{id}/documents": { "delete": { "tags": [ "Knowledge-Bases" ], "summary": "Delete Some Ingested Documents From A Knowledge-Base", "operationId": "Delete_some_ingested_documents_from_a_knowledge_base_v1_orchestrate_knowledge_bases__id__documents_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "title": "Doc Ids" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/knowledge-bases/{kb_id}/status": { "get": { "tags": [ "Knowledge-Bases" ], "summary": "Knowledge-Base Status", "operationId": "knowledge_base_status_v1_orchestrate_knowledge_bases__kb_id__status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "kb_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Kb Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/knowledge-bases": { "get": { "tags": [ "Knowledge-Bases" ], "summary": "Fetch Knowledge-Bases", "operationId": "Fetch_knowledge_bases_v1_orchestrate_knowledge_bases_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } }, { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search by name and description", "title": "Query" }, "description": "Search by name and description" }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ], "description": "Limit the number of results returned", "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "description": "Skip the first N results", "default": 0, "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/wo_archer__schema__agents__SortOptions" }, { "type": "null" } ], "description": "Sort by name and recently added (recent/asc/desc)", "default": "asc", "title": "Sort" }, "description": "Sort by name and recently added (recent/asc/desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ListKnowledgeBase" } }, { "$ref": "#/components/schemas/KnowledgeBasesResponseWithPagination" } ], "title": "Response Fetch Knowledge Bases V1 Orchestrate Knowledge Bases Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/threads/{thread_id}/chat-with-docs": { "post": { "tags": [ "Chat with Docs" ], "summary": "Create A Knowledge-Base By Uploading Documents, Or Providing An External Vector Index", "operationId": "Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_agents__agent_id__threads__thread_id__chat_with_docs_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Thread Id" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_agents__agent_id__threads__thread_id__chat_with_docs_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/threads/{thread_id}/chat-with-docs/status": { "get": { "tags": [ "Chat with Docs" ], "summary": "Get The Status For Knowledge Base Backing Chat With Docs For Thread", "operationId": "Get_the_status_for_Knowledge_Base_backing_Chat_with_Docs_for_thread_v1_orchestrate_agents__agent_id__threads__thread_id__chat_with_docs_status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "thread_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Thread Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/toolkits": { "post": { "tags": [ "Toolkits" ], "summary": "Create A Toolkit", "operationId": "Create_a_Toolkit_v1_toolkits_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateToolKit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Response Create A Toolkit V1 Toolkits Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Toolkits" ], "summary": "Fetch Toolkits", "operationId": "Fetch_Toolkits_v1_toolkits_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "ids", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Ids" } }, { "name": "names", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Names" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolKitOut" }, "title": "Response Fetch Toolkits V1 Toolkits Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/toolkits/{id}": { "get": { "tags": [ "Toolkits" ], "summary": "Get Toolkit By Id", "operationId": "Get_ToolKit_by_id_v1_toolkits__id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToolKitOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Toolkits" ], "summary": "Patch A Toolkit", "operationId": "Patch_a_Toolkit_v1_toolkits__id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchToolKit" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Toolkits" ], "summary": "Delete A Toolkit By Id", "operationId": "Delete_a_ToolKit_by_id_v1_toolkits__id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/toolkits/prepare/list-tools": { "post": { "tags": [ "Toolkits" ], "summary": "List Tools From Mcp Server Without Importing", "operationId": "List_tools_from_MCP_server_without_importing_v1_toolkits_prepare_list_tools_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_List_tools_from_MCP_server_without_importing_v1_toolkits_prepare_list_tools_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Response List Tools From Mcp Server Without Importing V1 Toolkits Prepare List Tools Post" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/toolkits/{id}/upload": { "post": { "tags": [ "Toolkits" ], "summary": "Upload Toolkits Supporting Artifact", "operationId": "Upload_toolkits_supporting_artifact_v1_toolkits__id__upload_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_toolkits_supporting_artifact_v1_toolkits__id__upload_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/toolkits/{id}/download": { "get": { "tags": [ "Toolkits" ], "summary": "Download Toolkits Supporting Artifact", "operationId": "Download_toolkits_supporting_artifact_v1_toolkits__id__download_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "File download", "content": { "application/json": { "schema": {} }, "application/zip": {} } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/models": { "post": { "tags": [ "Models" ], "summary": "Create Model", "operationId": "Create_Model_v1_models_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModelInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Models" ], "summary": "Fetch Models", "operationId": "Fetch_Models_v1_models_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Name" } }, { "name": "display_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Display Name" } }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ModelOut" }, "title": "Response Fetch Models V1 Models Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/models/list": { "get": { "tags": [ "Models" ], "summary": "List Models", "operationId": "List_Models_v1_models_list_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListModels" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/models/list/embeddings": { "get": { "tags": [ "Models" ], "summary": "List Embeddings Models", "operationId": "List_Embeddings_Models_v1_models_list_embeddings_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListModels" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/models/{model_id}": { "delete": { "tags": [ "Models" ], "summary": "Delete Model By Id", "operationId": "Delete_Model_by_ID_v1_models__model_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Model Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Models" ], "summary": "Update Model", "operationId": "Update_Model_v1_models__model_id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Model Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/model_policy": { "post": { "tags": [ "Model-Policy" ], "summary": "Create Model Policy", "operationId": "Create_Model_Policy_v1_model_policy_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModelConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Model-Policy" ], "summary": "Fetch Models Policy", "operationId": "Fetch_Models_policy_v1_model_policy_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Name" } }, { "name": "display_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Display Name" } }, { "name": "id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListModelConfig" }, "title": "Response Fetch Models Policy V1 Model Policy Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/model_policy/{model_policy_id}": { "delete": { "tags": [ "Model-Policy" ], "summary": "Delete Model Policy By Id", "operationId": "Delete_Model_policy_by_ID_v1_model_policy__model_policy_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_policy_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Model Policy Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Model-Policy" ], "summary": "Update Model", "operationId": "Update_Model_v1_model_policy__model_policy_id__put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "model_policy_id", "in": "path", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Model Policy Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchModelConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voice_configurations": { "post": { "tags": [ "Voice Configurations" ], "summary": "Create Voice Configuration", "operationId": "create_voice_configuration_v1_voice_configurations_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVoiceConfiguration" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Voice Configurations" ], "summary": "List Voice Configurations", "operationId": "list_voice_configurations_v1_voice_configurations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "query", "required": false, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voice_configurations/{voice_configuration_id}": { "get": { "tags": [ "Voice Configurations" ], "summary": "Get Voice Configuration", "operationId": "get_voice_configuration_v1_voice_configurations__voice_configuration_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "voice_configuration_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Voice Configuration Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Voice Configurations" ], "summary": "Update Voice Configuration", "operationId": "update_voice_configuration_v1_voice_configurations__voice_configuration_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "voice_configuration_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Voice Configuration Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoiceConfiguration" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Voice Configurations" ], "summary": "Delete Voice Configuration", "operationId": "delete_voice_configuration_v1_voice_configurations__voice_configuration_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "voice_configuration_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Voice Configuration Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/credentials/{tenant_id}": { "get": { "tags": [ "Credentials" ], "summary": "Get Datastore Credentials For A Tenant", "operationId": "Get_datastore_credentials_for_a_tenant_v1_credentials__tenant_id__get", "parameters": [ { "name": "tenant_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tenant Id" } }, { "name": "X-API-Key", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Api-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESCredentialsOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels": { "get": { "tags": [ "General Channel" ], "summary": "Get All Channels Environment", "operationId": "get_all_channels_environment_v1_orchestrate_agents__agent_id__environments__environment_id__channels_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/genesys_bot_connector": { "post": { "tags": [ "Genesys Bot Connector Channel" ], "summary": "Create Genesys Bot Connector Channel", "operationId": "create_genesys_bot_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_bot_connector_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGenesysBotConnectorChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Genesys Bot Connector Channel" ], "summary": "List Genesys Bot Connector Channels", "operationId": "list_genesys_bot_connector_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_bot_connector_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/genesys_bot_connector/{channel_id}": { "patch": { "tags": [ "Genesys Bot Connector Channel" ], "summary": "Update Genesys Bot Connector Channel", "operationId": "update_genesys_bot_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_bot_connector__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGenesysBotConnectorChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Genesys Bot Connector Channel" ], "summary": "Get Genesys Bot Connector Channel", "operationId": "get_genesys_bot_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_bot_connector__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Genesys Bot Connector Channel" ], "summary": "Delete Genesys Bot Connector Channel", "operationId": "delete_genesys_bot_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_bot_connector__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/teams": { "post": { "tags": [ "Teams Channel" ], "summary": "Create Teams Channel", "operationId": "create_teams_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_teams_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamsChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Teams Channel" ], "summary": "List Teams Channels", "operationId": "list_teams_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_teams_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/teams/{channel_id}": { "patch": { "tags": [ "Teams Channel" ], "summary": "Update Teams Channel", "operationId": "update_teams_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_teams__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamsChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Teams Channel" ], "summary": "Get Teams Channel", "operationId": "get_teams_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_teams__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Teams Channel" ], "summary": "Delete Teams Channel", "operationId": "delete_teams_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_teams__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/twilio_whatsapp": { "post": { "tags": [ "Twilio WhatsApp Channel" ], "summary": "Create Twilio Whatsapp Channel", "operationId": "create_twilio_whatsapp_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_whatsapp_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTwilioWhatsappChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Twilio WhatsApp Channel" ], "summary": "List Twilio Whatsapp Channels", "operationId": "list_twilio_whatsapp_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_whatsapp_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/twilio_whatsapp/{channel_id}": { "patch": { "tags": [ "Twilio WhatsApp Channel" ], "summary": "Update Twilio Whatsapp Channel", "operationId": "update_twilio_whatsapp_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_whatsapp__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTwilioWhatsappChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Twilio WhatsApp Channel" ], "summary": "Get Twilio Whatsapp Channel", "operationId": "get_twilio_whatsapp_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_whatsapp__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Twilio WhatsApp Channel" ], "summary": "Delete Twilio Whatsapp Channel", "operationId": "delete_twilio_whatsapp_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_whatsapp__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/twilio_sms": { "post": { "tags": [ "Twilio SMS Channel" ], "summary": "Create Twilio Sms Channel", "operationId": "create_twilio_sms_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_sms_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTwilioSMSChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Twilio SMS Channel" ], "summary": "List Twilio Sms Channels", "operationId": "list_twilio_sms_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_sms_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/twilio_sms/{channel_id}": { "patch": { "tags": [ "Twilio SMS Channel" ], "summary": "Update Twilio Sms Channel", "operationId": "update_twilio_sms_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_sms__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTwilioSMSChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Twilio SMS Channel" ], "summary": "Get Twilio Sms Channel", "operationId": "get_twilio_sms_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_sms__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Twilio SMS Channel" ], "summary": "Delete Twilio Sms Channel", "operationId": "delete_twilio_sms_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_twilio_sms__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/facebook": { "post": { "tags": [ "Facebook Channel" ], "summary": "Create Facebook Channel", "operationId": "create_facebook_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_facebook_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFacebookChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Facebook Channel" ], "summary": "List Facebook Channels", "operationId": "list_facebook_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_facebook_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/facebook/{channel_id}": { "patch": { "tags": [ "Facebook Channel" ], "summary": "Update Facebook Channel", "operationId": "update_facebook_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_facebook__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFacebookChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Facebook Channel" ], "summary": "Get Facebook Channel", "operationId": "get_facebook_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_facebook__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Facebook Channel" ], "summary": "Delete Facebook Channel", "operationId": "delete_facebook_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_facebook__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/genesys_audio_connector": { "post": { "tags": [ "GenesysAudioConnector Channel" ], "summary": "Create Genesys Audio Connector Channel", "operationId": "create_genesys_audio_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_audio_connector_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGenesysAudioConnectorChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "GenesysAudioConnector Channel" ], "summary": "List Genesys Audio Connector Channels", "operationId": "list_genesys_audio_connector_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_audio_connector_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/genesys_audio_connector/{channel_id}": { "patch": { "tags": [ "GenesysAudioConnector Channel" ], "summary": "Update Genesys Audio Connector Channel", "operationId": "update_genesys_audio_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_audio_connector__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGenesysAudioConnectorChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "GenesysAudioConnector Channel" ], "summary": "Get Genesys Audio Connector Channel", "operationId": "get_genesys_audio_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_audio_connector__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "GenesysAudioConnector Channel" ], "summary": "Delete Genesys Audio Connector Channel", "operationId": "delete_genesys_audio_connector_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_genesys_audio_connector__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/slack": { "post": { "tags": [ "Slack Channel" ], "summary": "Create Slack Channel", "operationId": "create_slack_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_slack_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSlackChannel" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Slack Channel" ], "summary": "List Slack Channels", "operationId": "list_slack_channels_v1_orchestrate_agents__agent_id__environments__environment_id__channels_slack_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agents/{agent_id}/environments/{environment_id}/channels/slack/{channel_id}": { "patch": { "tags": [ "Slack Channel" ], "summary": "Update Slack Channel", "operationId": "update_slack_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_slack__channel_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSlackChannel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Slack Channel" ], "summary": "Get Slack Channel", "operationId": "get_slack_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_slack__channel_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Slack Channel" ], "summary": "Delete Slack Channel", "operationId": "delete_slack_channel_v1_orchestrate_agents__agent_id__environments__environment_id__channels_slack__channel_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Channel Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/channels/phone": { "post": { "tags": [ "Phone channel global" ], "summary": "Create Phone Channel", "operationId": "create_phone_channel_v1_channels_phone_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePhoneConfig" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Phone channel global" ], "summary": "List Phone Configs", "operationId": "list_phone_configs_v1_channels_phone_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/channels/phone/{config_id}": { "patch": { "tags": [ "Phone channel global" ], "summary": "Update Phone Config", "operationId": "update_phone_config_v1_channels_phone__config_id__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } }, { "name": "append", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Append" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePhoneConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Phone channel global" ], "summary": "Get Phone Config", "operationId": "get_phone_config_v1_channels_phone__config_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } }, { "name": "x-watson-origin", "in": "header", "required": false, "schema": { "type": "string", "title": "X-Watson-Origin" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Phone channel global" ], "summary": "Delete Phone Config", "operationId": "delete_phone_config_v1_channels_phone__config_id__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/channels/phone/{config_id}/numbers": { "post": { "tags": [ "Phone channel global" ], "summary": "Add Phone Numbers", "operationId": "add_phone_numbers_v1_channels_phone__config_id__numbers_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePhoneNumberConfig" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Phone channel global" ], "summary": "List Phone Numbers", "operationId": "list_phone_numbers_v1_channels_phone__config_id__numbers_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/channels/phone/{config_id}/numbers/{number}": { "patch": { "tags": [ "Phone channel global" ], "summary": "Patch Phone Number", "operationId": "patch_phone_number_v1_channels_phone__config_id__numbers__number__patch", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string", "title": "Number" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePhoneNumberConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Phone channel global" ], "summary": "Delete Phone Number", "operationId": "delete_phone_number_v1_channels_phone__config_id__numbers__number__delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string", "title": "Number" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/flows/{flow_id}/run/async": { "post": { "tags": [ "Flows" ], "summary": "Asynchronously run the latest flow version", "operationId": "call_flow_v1_flows__flow_id__run_async_post", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "The flow execution request accepted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "instance_id": { "type": "string", "description": "The flow instance id" } }, "required": [ "instance_id" ] } } } }, "404": { "description": "The flow model does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "409": { "description": "The flow is in progress.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "410": { "description": "The flow is archived.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "500": { "description": "The flow execution failed with internal error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } } }, "description": "Asynchronously run the latest \"published\" version of a flow with a given flow id.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "AnyValue": { "type": "object", "description": "The output defined by the flow model" } } } } } }, "parameters": [ { "in": "header", "name": "x-ibm-wxo-thread-id", "description": "The watsonx Orchestrate message thread id.", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "x-ibm-flow-instance-id", "description": "The flow execution instance id. Only use this if you want to resume a previous flow execution.", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "callbackUrl", "description": "The callback url for sending the flow output", "required": false, "schema": { "type": "string" } }, { "in": "path", "name": "flow_id", "description": "The flow id", "required": true, "schema": { "type": "string" } } ], "callbacks": { "postResponse": { "{$request.header.callbackUrl}": { "post": { "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] }, "data": { "AnyValue": { "type": "object", "description": "The output defined by the flow model" } } } } } } }, "responses": { "200": { "description": "The flow output is received correctly" }, "500": { "description": "Internal server error" } } } } } }, "x-ibm-ahub-byok": true } }, "/v1/orchestrate/flows/{flow_id}/run": { "post": { "summary": "Run the latest flow version", "description": "Run the latest \"published\" version of a flow with a given flow ID.", "tags": [ "Flows" ], "operationId": "runFlow", "security": [ { "HTTPBearer": [] } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "The input defined by the flow model" } } } }, "parameters": [ { "in": "header", "name": "x-ibm-thread-id", "description": "The ID of the thread where the flow was started", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "x-ibm-environment-id", "description": "The target environment ID - draft or live", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "x-ibm-agent-id", "description": "The caller agent id", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "x-ibm-agent-version", "description": "The caller agent version", "required": false, "schema": { "type": "string" } }, { "in": "header", "name": "x-ibm-flow-execution-summary", "description": "Generate the flow execution summary. Default to false.", "required": false, "schema": { "type": "boolean" } }, { "in": "path", "name": "flow_id", "description": "The flow id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "request_timeout", "description": "The flow request timeout.", "required": false, "schema": { "type": "number", "default": 60000 } } ], "responses": { "200": { "description": "The flow execution is completed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "AnyValue": { "type": "object", "description": "The output defined by the flow model" } } } } } }, "404": { "description": "The flow model does not exist.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "409": { "description": "The flow is in progress.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "410": { "description": "The flow is archived.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "500": { "description": "The flow execution failed with internal error.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } } } } }, "/v1/orchestrate/flows/": { "get": { "tags": [ "Flows" ], "summary": "List flow instances", "operationId": "call_flow_v1_flows__get", "security": [ { "HTTPBearer": [] } ], "responses": { "200": { "description": "Flow runs return.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "400": { "description": "Bad input", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "additionalProperties": true, "required": [ "message" ] } }, "required": [ "data" ] } } } } }, "description": "List flows runs", "parameters": [ { "in": "query", "name": "flow_id", "schema": { "type": "string" } }, { "in": "query", "name": "version", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string", "enum": [ "completed", "in_progress", "interrupted", "failed" ] } }, { "in": "query", "name": "instance_id", "schema": { "type": "string" } }, { "in": "query", "name": "root_only", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "initiators", "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, { "in": "query", "name": "page", "schema": { "type": "number", "default": 1 } }, { "in": "query", "name": "page_size", "schema": { "type": "number", "default": 20 } } ], "x-ibm-ahub-byok": true } }, "/v1/orchestrate/agent/test_case/templates": { "get": { "tags": [ "Agent Evaluation" ], "summary": "Get A Sample Test Case Csv File ", "description": "Get CSV template for a given agent", "operationId": "Get_a_sample_test_case_CSV_file__v1_orchestrate_agent_test_case_templates_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/agent/{agent_id}/test_case": { "post": { "tags": [ "Agent Evaluation" ], "summary": "Upload Test Cases For A Given Agent", "description": "Upload test cases for a given agent", "operationId": "Upload_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_Upload_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadTestCasesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agent Evaluation" ], "summary": "List Test Cases For A Given Agent", "description": "List test cases for a given agent", "operationId": "List_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "description": "Search prompt", "default": "", "title": "Query" }, "description": "Search prompt" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Limit the number of results returned", "default": 5, "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Skip the first N results", "default": 0, "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sortkey", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortKey", "description": "Sort key", "default": "created_date" }, "description": "Sort key" }, { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/wo_archer__observability__models__base__SortOptions", "description": "Sort order", "default": "desc" }, "description": "Sort order" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestCasesListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/test_case/bulk_delete": { "post": { "tags": [ "Agent Evaluation" ], "summary": "Bulk Delete Test Cases For A Given Agent", "description": "Delete test cases for a given agent", "operationId": "Bulk_delete_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_bulk_delete_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BulkDeleteRequest" }, { "type": "null" } ], "title": "Delete Test Cases" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluate": { "post": { "tags": [ "Agent Evaluation" ], "summary": "Evaluate Test Cases For A Given Agent", "description": "Evaluate test cases for a given agent", "operationId": "Evaluate_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__evaluate_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/EvaluateTestcasesRequest" }, { "type": "null" } ], "title": "Evaluate Test Cases" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateTestcasesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations": { "get": { "tags": [ "Agent Evaluation" ], "summary": "List Evaluations For A Given Agent", "description": "List evaluations for a given agent", "operationId": "List_evaluations_for_a_given_agent_v1_orchestrate_agent__agent_id__evaluations_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Limit the number of results returned", "default": 5, "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Skip the first N results", "default": 0, "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sortkey", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/EvaluationSortKey", "description": "Sort key", "default": "executed_date" }, "description": "Sort key" }, { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/wo_archer__observability__models__base__SortOptions", "description": "Sort order", "default": "desc" }, "description": "Sort order" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations/bulk_delete": { "post": { "tags": [ "Agent Evaluation" ], "summary": "Bulk Delete Evaluations For A Given Agent", "description": "Delete evaluations for a given agent", "operationId": "Bulk_delete_evaluations_for_a_given_agent_v1_orchestrate_agent__agent_id__evaluations_bulk_delete_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BulkDeleteRequest" }, { "type": "null" } ], "title": "Delete Evaluations" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations/export": { "post": { "tags": [ "Agent Evaluation" ], "summary": "Export Evaluations Of A Given Agent", "description": "Download evaluations for a given agent", "operationId": "Export_evaluations_of_a_given_agent_v1_orchestrate_agent__agent_id__evaluations_export_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportEvaluationRequest" } } } }, "responses": { "200": { "description": "Returns a CSV file for a single evaluation or a ZIP file for multiple evaluations", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations/status": { "get": { "tags": [ "Agent Evaluation" ], "summary": "Get Current Running Evaluation For A Given Agent", "description": "Get evaluation status for a given agent", "operationId": "Get_current_running_evaluation_for_a_given_agent_v1_orchestrate_agent__agent_id__evaluations_status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations/{evaluation_id}": { "get": { "tags": [ "Agent Evaluation" ], "summary": "Get Evaluation Details", "description": "Get evaluation details for a given agent", "operationId": "Get_evaluation_details_v1_orchestrate_agent__agent_id__evaluations__evaluation_id__get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "evaluation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Evaluation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/agent/{agent_id}/evaluations/{evaluation_id}/test_cases": { "get": { "tags": [ "Agent Evaluation" ], "summary": "Get Test Cases Of An Evaluation For A Given Agent", "description": "Get evaluation test cases for a given agent", "operationId": "Get_test_cases_of_an_evaluation_for_a_given_agent_v1_orchestrate_agent__agent_id__evaluations__evaluation_id__test_cases_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "evaluation_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Evaluation Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/EvaluationTestCasesFilter", "description": "Test case status" }, "description": "Test case status" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Limit the number of results returned", "default": 5, "title": "Limit" }, "description": "Limit the number of results returned" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Skip the first N results", "default": 0, "title": "Offset" }, "description": "Skip the first N results" }, { "name": "sortkey", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/SortKey", "description": "Sort key", "default": "created_date" }, "description": "Sort key" }, { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/wo_archer__observability__models__base__SortOptions", "description": "Sort order", "default": "desc" }, "description": "Sort order" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluationTestCasesListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/orchestrate/monitoring/availability/status": { "get": { "tags": [ "Governance monitoring" ], "summary": "Check Monitoring Availability", "description": "Check if monitoring is available", "operationId": "Check_monitoring_availability_v1_orchestrate_monitoring_availability_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringStatus" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/monitoring/agents/{agent_id}/status": { "post": { "tags": [ "Governance monitoring" ], "summary": "Setup Agent Monitoring", "description": "Setup agent monitoring", "operationId": "Setup_agent_monitoring_v1_orchestrate_monitoring_agents__agent_id__status_post", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupAgentMonitoringRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentMonitoringStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Governance monitoring" ], "summary": "Get Agent Monitoring Details", "description": "Get agent monitoring details", "operationId": "Get_agent_monitoring_details_v1_orchestrate_monitoring_agents__agent_id__status_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentMonitoringStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/outbound-policies": { "post": { "tags": [ "Outbound Policies" ], "summary": "Create Policies", "operationId": "Create_policies_v1_outbound_policies_post", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Outbound Policies" ], "summary": "Fetch Outbound Policy For Tenant", "operationId": "Fetch_OutBound_Policy_For_Tenant_v1_outbound_policies_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "flat", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Return a flat list if True", "default": false, "title": "Flat" }, "description": "Return a flat list if True" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Outbound Policies" ], "summary": "Update Policies By Ids", "operationId": "Update_policies_by_IDs_v1_outbound_policies_put", "security": [ { "HTTPBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/wo_archer__schema__outbound_policy__UpdatePolicyRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePolicyResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Outbound Policies" ], "summary": "Delete Policies By Ids", "operationId": "Delete_Policies_by_IDs_v1_outbound_policies_delete", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "delete_all", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Delete all policy for a tenant", "default": false, "title": "Delete All" }, "description": "Delete all policy for a tenant" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DeletePolicyRequest" }, { "type": "null" } ], "title": "Request" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/outbound-policies/is-allow": { "post": { "tags": [ "Outbound Policies" ], "summary": "Api To Check The Url/Set Of Url Is Allowed Or Not", "operationId": "API_to_check_the_URL_set_of_URL_is_allowed_or_not_v1_outbound_policies_is_allow_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLCheckRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/orchestrate/agents/{id}/embedded-chat-config": { "put": { "tags": [ "Agent embedded chat config" ], "summary": "Create Or Update Embedded Chat Config For A Registered Agent", "description": "Create or update embedded chat config for a registered agent.", "operationId": "Create_or_update_embedded_chat_config_for_a_registered_agent_v1_orchestrate_agents__id__embedded_chat_config_put", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddedChatConfigIn" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddedChatConfigOut" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Agent embedded chat config" ], "summary": "Get Embedded Chat Config For A Registered Agent", "description": "Retrieves embedded chat config for a specific agent by its id.", "operationId": "Get_embedded_chat_config_for_a_registered_agent_v1_orchestrate_agents__id__embedded_chat_config_get", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddedChatConfigResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "APIError": { "type": "object", "properties": { "errorCode": { "type": "integer", "description": "A unique code for this type of error." }, "errorMessage": { "type": "string", "description": "A human-readable message describing the error." }, "details": { "type": "string", "description": "Additional details about the error." } }, "required": [ "errorCode", "errorMessage" ] }, "A2ASupportedVersionsResponse": { "properties": { "protocol": { "type": "string", "title": "Protocol", "description": "Protocol name", "default": "A2A" }, "role": { "type": "string", "enum": [ "client", "server" ], "title": "Role", "description": "Role type (client or server)" }, "versions": { "items": { "$ref": "#/components/schemas/A2AVersionInfo" }, "type": "array", "title": "Versions", "description": "List of supported versions with their features" }, "current_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Version", "description": "Current/recommended version for this role" }, "is_implemented": { "type": "boolean", "title": "Is Implemented", "description": "Whether this role is currently implemented" } }, "type": "object", "required": [ "role", "versions", "current_version", "is_implemented" ], "title": "A2ASupportedVersionsResponse", "description": "Response model for A2A supported versions endpoint." }, "A2AVersionInfo": { "properties": { "version": { "type": "string", "title": "Version", "description": "Version string (e.g., '0.3.0')" }, "status": { "type": "string", "enum": [ "current", "supported", "deprecated", "unsupported" ], "title": "Status", "description": "Version status indicator" }, "features": { "$ref": "#/components/schemas/VersionFeatures", "description": "Feature support matrix for this version" } }, "type": "object", "required": [ "version", "status", "features" ], "title": "A2AVersionInfo", "description": "Information about a specific A2A protocol version." }, "AcknowledgementResponseBody-Input": { "properties": { "output_schema": { "$ref": "#/components/schemas/ToolResponseBody-Input", "description": "The schema of the original response from the callback." } }, "type": "object", "required": [ "output_schema" ], "title": "AcknowledgementResponseBody", "description": "An acknowledgment for the tools that are async" }, "AcknowledgementResponseBody-Output": { "properties": { "output_schema": { "$ref": "#/components/schemas/ToolResponseBody-Output", "description": "The schema of the original response from the callback." } }, "type": "object", "required": [ "output_schema" ], "title": "AcknowledgementResponseBody", "description": "An acknowledgment for the tools that are async" }, "AddSkillRequest": { "properties": { "artifact_id": { "type": "string", "format": "uuid", "title": "Artifact Id", "description": "Artifact Id" }, "artifact_group_id": { "type": "string", "format": "uuid", "title": "Artifact Group Id", "description": "Artifact Group Id" }, "routing_description": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Routing Description", "description": "Routing description for the artifact" } }, "type": "object", "required": [ "artifact_id", "artifact_group_id", "routing_description" ], "title": "AddSkillRequest" }, "AdditionalProperties": { "properties": { "wxa_message": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Wxa Message" }, "display_properties": { "anyOf": [ { "$ref": "#/components/schemas/DisplayProperties" }, { "type": "null" } ] }, "tool_calls": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tool Calls" }, "tool_call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Call Id" }, "tool_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Name" }, "wxo_connection_status": { "anyOf": [ { "$ref": "#/components/schemas/WxoConnectionStatus" }, { "type": "null" } ] } }, "type": "object", "title": "AdditionalProperties" }, "AgentAdditionalProperties": { "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "xml strings or encoded base64 image data" }, "starter_prompts": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Starter Prompts", "description": "Agent Starter Prompts (nested by language)" }, "welcome_content": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Welcome Content", "description": "Agent Welcome Message (nested by language)" }, "context_settings": { "anyOf": [ { "$ref": "#/components/schemas/ContextSettings" }, { "type": "null" } ], "description": "Context management settings" }, "realtime_agent_settings": { "anyOf": [ { "$ref": "#/components/schemas/RealtimeAgentSettings" }, { "type": "null" } ], "description": "Realtime Agent Settings" } }, "type": "object", "title": "AgentAdditionalProperties", "description": "A specification for settings within an agent.\n\nThis schema is used for OUTPUT (reading from database).\nDatabase stores nested format: {\"en\": [...], \"es\": [...]}\nUsing Dict[str, Any] preserves the nested language structure." }, "AgentAdditionalPropertiesIn": { "properties": { "starter_prompts": { "anyOf": [ { "$ref": "#/components/schemas/AgentCustomizedPromptsIn" }, { "type": "null" } ], "description": "Agent Starter Prompts" }, "welcome_content": { "anyOf": [ { "$ref": "#/components/schemas/AgentWelcomeContentIn" }, { "type": "null" } ], "description": "Agent Welcome Message" }, "icon": { "anyOf": [ { "$ref": "#/components/schemas/AgentSvgIcon" }, { "type": "null" } ], "description": "Agent Icon (SVG)" }, "realtime_agent_settings": { "anyOf": [ { "$ref": "#/components/schemas/RealtimeAgentSettingsIn" }, { "type": "null" } ], "description": "Realtime Agent Settings" }, "context_settings": { "anyOf": [ { "$ref": "#/components/schemas/ContextSettings" }, { "type": "null" } ], "description": "Context management settings" } }, "type": "object", "title": "AgentAdditionalPropertiesIn", "description": "A specification for creating settings within an agent.\nValidation runs for Input." }, "AgentChatStarterSettingsIn": { "properties": { "starter_prompts": { "anyOf": [ { "$ref": "#/components/schemas/AgentCustomizedPromptsIn" }, { "type": "null" } ], "description": "Agent Starter Prompts" }, "welcome_content": { "anyOf": [ { "$ref": "#/components/schemas/AgentWelcomeContentIn" }, { "type": "null" } ], "description": "Agent Welcome Message" }, "icon": { "anyOf": [ { "$ref": "#/components/schemas/AgentSvgIcon" }, { "type": "null" } ], "description": "Agent Icon (SVG)" } }, "type": "object", "title": "AgentChatStarterSettingsIn", "description": "A specification for chat starter settings within an agent" }, "AgentChatStarterSettingsOut": { "properties": { "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "xml strings or encoded base64 image data" }, "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Id", "description": "Unique identifier for the agent or no_agent for UI get" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this agent" }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user who created the agent" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ], "title": "Created On", "description": "Creation timestamp" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" } ], "title": "Updated At", "description": "Last update timestamp" }, "updated_by": { "type": "string", "title": "Updated By", "description": "ID of the user who updated the agent" }, "starter_prompts": { "$ref": "#/components/schemas/AgentPromptsOut", "description": "Agent Starter Prompts" }, "welcome_content": { "$ref": "#/components/schemas/AgentWelcomeContentOut", "description": "Agent Welcome Message" } }, "type": "object", "required": [ "id", "tenant_id", "created_by", "created_on", "updated_at", "updated_by", "starter_prompts", "welcome_content" ], "title": "AgentChatStarterSettingsOut", "description": "A specification for chat starter settings within an agent" }, "AgentCustomizedPromptsBase": { "properties": { "customize": { "items": { "$ref": "#/components/schemas/AgentPrompt" }, "type": "array", "title": "Customize", "description": "list of starter prompts of the agent" } }, "type": "object", "title": "AgentCustomizedPromptsBase" }, "AgentCustomizedPromptsIn": { "properties": { "customize": { "items": { "$ref": "#/components/schemas/AgentPrompt" }, "type": "array", "title": "Customize", "description": "list of starter prompts of the agent" } }, "type": "object", "title": "AgentCustomizedPromptsIn" }, "AgentIdleHandler": { "properties": { "pre_hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Pre Hold Message", "description": "The text to play for the user before playing on-hold audio", "default": "We're taking a little extra time but we'll be with you shortly. Thanks for your patience!" }, "hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Hold Message", "description": "The text to play to the user periodically while on hold", "default": "Your request is in progress. It might take a little time, but we assure you that the result will be worth the wait." }, "typing_enabled": { "type": "boolean", "title": "Typing Enabled", "default": true }, "typing_duration_seconds": { "type": "integer", "maximum": 30.0, "minimum": 0.0, "title": "Typing Duration Seconds", "default": 5 }, "audio_clip_id": { "$ref": "#/components/schemas/AudioClips", "default": "guitar_1" }, "hold_audio_seconds": { "type": "integer", "maximum": 120.0, "minimum": 0.0, "title": "Hold Audio Seconds", "default": 15 } }, "type": "object", "title": "AgentIdleHandler" }, "AgentIdleHandlerMessages": { "properties": { "pre_hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Pre Hold Message", "description": "The text to play for the user before playing on-hold audio", "default": "We're taking a little extra time but we'll be with you shortly. Thanks for your patience!" }, "hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Hold Message", "description": "The text to play to the user periodically while on hold", "default": "Your request is in progress. It might take a little time, but we assure you that the result will be worth the wait." } }, "type": "object", "title": "AgentIdleHandlerMessages" }, "AgentMonitoringStatusResponse": { "properties": { "monitoring_enabled": { "type": "boolean", "title": "Monitoring Enabled", "description": "Enable/disable status of agent monitoring" }, "wxg_metrics_url": { "type": "string", "title": "Wxg Metrics Url", "description": "WXO metrics url" } }, "type": "object", "required": [ "monitoring_enabled", "wxg_metrics_url" ], "title": "AgentMonitoringStatusResponse" }, "AgentPrompt": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the prompt" }, "title": { "type": "string", "title": "Title", "description": "Title of the prompt" }, "subtitle": { "type": "string", "title": "Subtitle", "description": "description of the prompt" }, "prompt": { "type": "string", "title": "Prompt", "description": "contents of the prompt" }, "state": { "type": "string", "title": "State", "description": "active/inactivate" } }, "type": "object", "required": [ "title", "prompt" ], "title": "AgentPrompt" }, "AgentPromptsOut": { "properties": { "prompts": { "items": { "$ref": "#/components/schemas/AgentPrompt" }, "type": "array", "title": "Prompts", "description": "list of starter prompts of the agent" }, "is_default_prompts": { "type": "boolean", "title": "Is Default Prompts", "description": "is the prompts default or not", "default": false } }, "type": "object", "title": "AgentPromptsOut" }, "AgentRestrictionsEnum": { "type": "string", "enum": [ "editable", "non_editable", "custom" ], "title": "AgentRestrictionsEnum" }, "AgentStyle": { "type": "string", "enum": [ "default", "react", "planner", "custom", "react_intrinsic", "experimental_customer_care", "code_act" ], "title": "AgentStyle" }, "AgentSvgIcon": { "type": "string", "title": "AgentSvgIcon", "description": "A raw SVG XML string (normalized from bytes / single- / double-escaped)\nthat passes square-icon validation. When serialized, it's just a string." }, "AgentToolVersionMinimal": { "properties": { "tool_id": { "type": "string", "format": "uuid", "title": "Tool Id", "description": "Unique Identifier of the tool" }, "version_label": { "type": "integer", "title": "Version Label", "description": "Version Label" }, "tool_version_id": { "type": "string", "format": "uuid", "title": "Tool Version Id", "description": "Tool ID of the agent version" }, "name": { "type": "string", "title": "Name", "description": "Tool name" }, "display_name": { "type": "string", "title": "Display Name", "description": "Tool display name" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id", "description": "Associated agent id" } }, "type": "object", "required": [ "tool_id", "version_label", "tool_version_id", "name", "display_name", "agent_id" ], "title": "AgentToolVersionMinimal", "description": "A minimal details of a tool that is part of an agent version" }, "AgentType": { "type": "string", "enum": [ "external_chat", "watsonx", "native" ], "title": "AgentType" }, "AgentVersion": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the agent" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this agent" }, "name": { "type": "string", "title": "Name", "description": "Name of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "version_label": { "type": "integer", "title": "Version Label", "description": "Version of the deployed agent" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for the agent" }, "tools": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array", "title": "Tools", "description": "List of tool names available to the agent" }, "collaborators": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array", "title": "Collaborators", "description": "List of other agent names this agent can collaborate with" }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "LLM identifier for the agent" }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user who created the agent" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Last update timestamp" }, "updated_by": { "type": "string", "title": "Updated By", "description": "ID of the user who updated the agent" }, "style": { "$ref": "#/components/schemas/AgentStyle", "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "agent_mapping": { "additionalProperties": { "$ref": "#/components/schemas/AgentType" }, "type": "object", "title": "Agent Mapping", "description": "Mapping of agent IDs to their respective agent types" }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed", "default": false }, "points_to": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Points To", "description": "Environment IDs points to this version", "default": [] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comments", "description": "Comments added by the user while deploying an agent" }, "mapped_environments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array" }, { "type": "null" } ], "title": "Mapped Environments", "description": "List of Environments points to the agent version", "default": [] }, "knowledge_base": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Base", "description": "List of knowledge_base available to the agent", "default": [] }, "environments": { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array", "title": "Environments", "description": "List of simplified environments associated with the agent", "default": [] }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "guidelines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array" }, { "type": "null" } ], "title": "Guidelines", "description": "List of guidelines for the agent behavior", "default": [] }, "custom_join_tool": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool ID that will be used for custom synthesis of task results", "default": {} }, "deployment_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Status", "description": "Status of the agent deployment" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalProperties" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "chat_with_docs": { "anyOf": [ { "$ref": "#/components/schemas/ChatWithDocsConfig-Output" }, { "type": "null" } ], "description": "Chat with Documents config for Agent Version" }, "name_for_llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name For Llm" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] }, "hide_reasoning": { "type": "boolean", "title": "Hide Reasoning", "description": "Enable/disable reasoning trace", "default": false }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig-Output" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "tenant_id", "name", "description", "version_label", "created_by", "created_on", "updated_at", "updated_by", "style", "agent_mapping" ], "title": "AgentVersion", "description": "Schema for a complete agent version." }, "AgentWelcomeContentBase": { "properties": { "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message", "description": "Welcome message" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description" } }, "type": "object", "title": "AgentWelcomeContentBase" }, "AgentWelcomeContentIn": { "properties": { "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message", "description": "Welcome message" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description" }, "is_default_voice_greeting": { "type": "boolean", "title": "Is Default Voice Greeting", "description": "is the welcome message the default voice greeting", "default": false } }, "type": "object", "title": "AgentWelcomeContentIn" }, "AgentWelcomeContentOut": { "properties": { "welcome_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Welcome Message", "description": "Welcome message" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description" }, "is_default_message": { "type": "boolean", "title": "Is Default Message", "description": "is the welcome message default or not", "default": false }, "is_default_description": { "type": "boolean", "title": "Is Default Description", "description": "is the welcome message description default or not", "default": false } }, "type": "object", "title": "AgentWelcomeContentOut" }, "AnswerQualityMetrics": { "properties": { "average": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "relevance": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "correctness": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "faithfulness": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] } }, "type": "object", "title": "AnswerQualityMetrics" }, "AppDetailsResponseModel": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Primary key of the artifact group" }, "application_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Application Id", "description": "Application Id / Catalog Ref. Id" }, "group_name": { "type": "string", "minLength": 1, "title": "Group Name", "description": "Name of the artifact group" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the artifact group" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "Icon associated with the artifact group" } }, "type": "object", "required": [ "id", "application_id", "group_name", "description" ], "title": "AppDetailsResponseModel" }, "ArtifactGroup": { "properties": { "ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Ids", "default": [] }, "catalog_ref_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Catalog Ref Id", "description": "App Id" }, "group_name": { "type": "string", "minLength": 1, "title": "Group Name", "description": "Name of the artifact group" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the artifact group" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "Icon associated with the artifact group" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden", "description": "Visibility of the artifact group", "default": false }, "tenant_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Tenant Id", "description": "Foreign key referencing the tenants table" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On", "description": "Timestamp when the artifact group was created" }, "created_by": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Created By", "description": "Foreign key referencing the user_profiles table for the creator" }, "last_modified_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Modified On", "description": "Timestamp of the last modification" }, "last_modified_by": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Last Modified By", "description": "Foreign key referencing the user_profiles table for the last modifier" }, "deleted_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted On", "description": "Timestamp when the artifact group was deleted" }, "deleted_by": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Deleted By", "description": "Foreign key referencing the user_profiles table for the user who deleted the artifact group" } }, "type": "object", "required": [ "group_name" ], "title": "ArtifactGroup" }, "ArtifactGroupIdentifier": { "type": "string", "enum": [ "catalog_ref_id" ], "title": "ArtifactGroupIdentifier" }, "AssistantContent": { "properties": { "response_type": { "$ref": "#/components/schemas/AssistantContentType" }, "json_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Json Schema" }, "ui_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ui Schema" }, "form_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Form Data", "default": {} }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "form_operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form Operation" }, "sub_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub Type" }, "event_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Event Type" }, "dps_payload_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dps Payload Id" } }, "additionalProperties": true, "type": "object", "required": [ "response_type" ], "title": "AssistantContent" }, "AssistantContentType": { "type": "string", "enum": [ "conversational_search", "text", "image", "option", "pause", "iframe", "connect_to_agent", "suggestion", "channel_transfer", "search", "user_defined", "video", "audio", "date", "inline_error", "chat_with_docs_upload", "disconnected_apps", "forms", "form_operation", "document_processing_response" ], "title": "AssistantContentType" }, "AssistantInfo": { "properties": { "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "assistant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Name" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false } }, "type": "object", "title": "AssistantInfo" }, "AssistantMention": { "properties": { "assistant_id": { "type": "string", "format": "uuid", "title": "Assistant Id" }, "assistant_name": { "type": "string", "title": "Assistant Name" } }, "type": "object", "required": [ "assistant_id", "assistant_name" ], "title": "AssistantMention" }, "AssistantRun": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "thread_id": { "type": "string", "format": "uuid", "title": "Thread Id" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/AssistantRunStatus" }, { "type": "null" } ], "default": "pending" }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At" }, "started_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Started At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "failed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Failed At" }, "cancelled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Cancelled At" }, "llm_params": { "anyOf": [ { "$ref": "#/components/schemas/TextGenerationParameters" }, { "type": "null" } ] }, "usage": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Usage" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "result": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Result" }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/Guardrails-Output" }, { "type": "null" } ] }, "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "additional_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Additional Parameters" }, "trace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trace Id" } }, "type": "object", "required": [ "id", "thread_id" ], "title": "AssistantRun" }, "AssistantRunCancelResponse": { "properties": { "thread_id": { "type": "string", "format": "uuid", "title": "Thread Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" } }, "type": "object", "required": [ "thread_id", "run_id" ], "title": "AssistantRunCancelResponse" }, "AssistantRunResponse": { "properties": { "thread_id": { "type": "string", "format": "uuid", "title": "Thread Id" }, "run_id": { "type": "string", "format": "uuid", "title": "Run Id" }, "task_id": { "type": "string", "format": "uuid", "title": "Task Id" }, "message_id": { "type": "string", "format": "uuid", "title": "Message Id" } }, "type": "object", "required": [ "thread_id", "run_id", "task_id", "message_id" ], "title": "AssistantRunResponse" }, "AssistantRunStatus": { "type": "string", "enum": [ "pending", "running", "completed", "async_wait", "async_completed", "failed", "cancelled", "requires_input", "expired" ], "title": "AssistantRunStatus" }, "AstraDBConnection": { "properties": { "api_endpoint": { "type": "string", "title": "Api Endpoint" }, "port": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port" }, "server_cert": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Cert" }, "keyspace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Keyspace" }, "data_type": { "anyOf": [ { "$ref": "#/components/schemas/DataType" }, { "type": "null" } ] }, "collection": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection" }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table" }, "index_column": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Index Column" }, "embedding_mode": { "anyOf": [ { "$ref": "#/components/schemas/EmbeddingMode" }, { "type": "null" } ] }, "embedding_model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embedding Model Id" }, "search_mode": { "anyOf": [ { "$ref": "#/components/schemas/SearchMode" }, { "type": "null" } ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "default": 5 }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" }, "field_mapping": { "$ref": "#/components/schemas/FieldMapping" } }, "type": "object", "required": [ "api_endpoint" ], "title": "AstraDBConnection", "description": "example:\n{\n \"api_endpoint\": \"https://xxx-us-east-2.apps.astra.datastax.com\",\n \"key_space\": \"default_keyspace\",\n \"collection\": \"search_wa_docs\",\n \"embedding_model_id\": \"sentence-transformers/all-minilm-l12-v2\",\n \"port\": \"443\",\n \"filter\": \"productType: \"boots\"\",\n \"limit\": 5,\n \"field_mapping\": {\n \"title\": \"title\",\n \"body\": \"text\",\n \"url\": \"some-url\"\n }\n}" }, "AudioClips": { "type": "string", "enum": [ "guitar_1", "listen_1" ], "title": "AudioClips" }, "AudioConfig": { "properties": { "voice": { "type": "string", "title": "Voice" }, "format": { "type": "string", "title": "Format" } }, "type": "object", "required": [ "voice", "format" ], "title": "AudioConfig" }, "BackgroundTask": { "properties": { "task_id": { "type": "string", "title": "Task Id" }, "task_name": { "type": "string", "title": "Task Name" }, "status": { "$ref": "#/components/schemas/TaskStatus", "default": "unknown" }, "task_obj": { "anyOf": [ {}, { "type": "null" } ], "title": "Task Obj" } }, "type": "object", "required": [ "task_id", "task_name" ], "title": "BackgroundTask" }, "BackgroundTaskOut": { "properties": { "task_id": { "type": "string", "title": "Task Id" }, "task_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Task Name" }, "status": { "$ref": "#/components/schemas/TaskStatus", "default": "unknown" }, "task_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Task Args" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" } }, "type": "object", "required": [ "task_id" ], "title": "BackgroundTaskOut" }, "BaseCreateAgent": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for the agent" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tool names available to the agent", "default": [] }, "collaborators": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Collaborators", "description": "List of other agent names this agent can collaborate with", "default": [] }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "LLM identifier for the agent" }, "style": { "$ref": "#/components/schemas/AgentStyle", "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "glossary": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Glossary", "description": "List of glossary available to the agent", "default": [] }, "guidelines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array" }, { "type": "null" } ], "title": "Guidelines", "description": "List of guidelines for the agent behavior", "default": [] }, "knowledge_base": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Base", "description": "List of knowledge_base available to the agent", "default": [] }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed", "default": false }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "custom_join_tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool ID that will be used for custom synthesis of task results" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalPropertiesIn" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "chat_with_docs": { "anyOf": [ { "$ref": "#/components/schemas/ChatWithDocsConfig" }, { "type": "null" } ], "description": "Chat with Documents config for Agent" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] }, "connection_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Connection Ids", "description": "List of connection IDs for direct agent-to-connection bindings", "default": [] }, "hide_reasoning": { "type": "boolean", "title": "Hide Reasoning", "description": "Enable/disable reasoning trace", "default": false }, "sync_tool_flow_interactions": { "type": "boolean", "title": "Sync Tool Flow Interactions", "description": "Enable/disable syncing user interactions from tool flow to the agent", "default": true }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "restrictions": { "$ref": "#/components/schemas/AgentRestrictionsEnum", "description": "Enable editable for the collaborator agent", "default": "editable" }, "bundled_agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bundled Agent Id", "description": "Base agent id" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id", "description": "ID of the workspace that owns this agent", "default": "00000000-0000-0000-0000-000000000001" }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig" }, { "type": "null" } ] }, "plugins": { "anyOf": [ { "$ref": "#/components/schemas/Plugins" }, { "type": "null" } ], "description": "Plugins and hook points associated to the agents" }, "toolkits": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Toolkits", "description": "List of toolkit ids available to the agent", "default": [] }, "memory_enabled": { "type": "boolean", "title": "Memory Enabled", "description": "Enable/disable agentic memory for this agent", "default": false }, "is_schedulable": { "type": "boolean", "title": "Is Schedulable", "description": "Indicates whether this agent can be scheduled", "default": false } }, "type": "object", "required": [ "description", "style" ], "title": "BaseCreateAgent", "description": "Schema for creating a new agent." }, "BaseLLMSettings-Input": { "properties": { "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name", "description": "Name of the model to use as the base LLM. Must be a valid model name available on watsonx.ai." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id", "description": "The ID of a custom configured model to use as the base LLM model used by Orchestrate." }, "model_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model Params", "description": "Default models params to use." }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/Guardrails-Input" }, { "type": "null" } ], "description": "Default AI safety guardrails settings." }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt", "description": "Override the system prompt used by the Orchestrate base LLM." }, "prompt_templates": { "anyOf": [ { "$ref": "#/components/schemas/PromptTemplates" }, { "type": "null" } ], "description": "LLM specific prompt templates using Jinja2 format." } }, "additionalProperties": false, "type": "object", "title": "BaseLLMSettings" }, "BaseLLMSettings-Output": { "properties": { "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name", "description": "Name of the model to use as the base LLM. Must be a valid model name available on watsonx.ai." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id", "description": "The ID of a custom configured model to use as the base LLM model used by Orchestrate." }, "model_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model Params", "description": "Default models params to use." }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/Guardrails-Output" }, { "type": "null" } ], "description": "Default AI safety guardrails settings." }, "system_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "System Prompt", "description": "Override the system prompt used by the Orchestrate base LLM." } }, "additionalProperties": false, "type": "object", "title": "BaseLLMSettings" }, "Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_agents__agent_id__threads__thread_id__chat_with_docs_post": { "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "title": "Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_agents__agent_id__threads__thread_id__chat_with_docs_post" }, "Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases_documents_post": { "properties": { "knowledge_base": { "type": "string", "contentMediaType": "application/json", "contentSchema": {}, "title": "Knowledge Base" }, "file_urls": { "type": "string", "contentMediaType": "application/json", "contentSchema": {}, "title": "File Urls" }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "required": [ "knowledge_base" ], "title": "Body_Create_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases_documents_post" }, "Body_Create_or_update_icon_for_agent_v1_orchestrate_agents__id__chat_starter_settings_icon_put": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Create_or_update_icon_for_agent_v1_orchestrate_agents__id__chat_starter_settings_icon_put" }, "Body_Ingest_additional_documents_into_a_knowledge_base_v1_orchestrate_knowledge_bases__kb_id__documents_put": { "properties": { "file_urls": { "type": "string", "contentMediaType": "application/json", "contentSchema": {}, "title": "File Urls" }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "title": "Body_Ingest_additional_documents_into_a_knowledge_base_v1_orchestrate_knowledge_bases__kb_id__documents_put" }, "Body_List_tools_from_MCP_server_without_importing_v1_toolkits_prepare_list_tools_post": { "properties": { "list_toolkit_obj": { "type": "string", "title": "List Toolkit Obj" }, "file": { "anyOf": [ { "type": "string", "format": "binary" }, { "type": "null" } ], "title": "File" } }, "type": "object", "required": [ "list_toolkit_obj" ], "title": "Body_List_tools_from_MCP_server_without_importing_v1_toolkits_prepare_list_tools_post" }, "Body_Login_for_Token_v1_auth_token_post": { "properties": { "grant_type": { "anyOf": [ { "type": "string", "pattern": "^password$" }, { "type": "null" } ], "title": "Grant Type" }, "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "format": "password", "title": "Password" }, "scope": { "type": "string", "title": "Scope", "default": "" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "format": "password", "title": "Client Secret" } }, "type": "object", "required": [ "username", "password" ], "title": "Body_Login_for_Token_v1_auth_token_post" }, "Body_Patch_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases__kb_id__documents_patch": { "properties": { "knowledge_base": { "type": "string", "contentMediaType": "application/json", "contentSchema": {}, "title": "Knowledge Base" }, "file_urls": { "type": "string", "contentMediaType": "application/json", "contentSchema": {}, "title": "File Urls" }, "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" } }, "type": "object", "required": [ "knowledge_base" ], "title": "Body_Patch_a_knowledge_base_by_uploading_documents__or_providing_a_external_vector_index_v1_orchestrate_knowledge_bases__kb_id__documents_patch" }, "Body_Upload_Document_v1_documents__doc_id__upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_Document_v1_documents__doc_id__upload_post" }, "Body_Upload_File_to_a_Custom_Assistant_v1_assistants_custom__assistant_id__files_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_File_to_a_Custom_Assistant_v1_assistants_custom__assistant_id__files_post" }, "Body_Upload_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_test_cases_for_a_given_agent_v1_orchestrate_agent__agent_id__test_case_post" }, "Body_Upload_toolkits_supporting_artifact_v1_toolkits__id__upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_toolkits_supporting_artifact_v1_toolkits__id__upload_post" }, "Body_Upload_tools_supporting_artifact_v1_tools__id__upload_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_Upload_tools_supporting_artifact_v1_tools__id__upload_post" }, "BulkDeleteRequest": { "properties": { "ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Ids" } }, "type": "object", "required": [ "ids" ], "title": "BulkDeleteRequest" }, "BulkDeleteResponse": { "properties": { "deleted_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Deleted Ids" } }, "type": "object", "required": [ "deleted_ids" ], "title": "BulkDeleteResponse" }, "CacheConfig": { "properties": { "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" } }, "type": "object", "title": "CacheConfig" }, "CallbackBinding-Input": { "properties": { "callback_url": { "type": "string", "title": "Callback Url", "description": "The URL to send the callback to" }, "method": { "$ref": "#/components/schemas/HTTP_METHOD", "description": "The HTTP method to use for the callback" }, "input_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolRequestBody-Input" }, { "type": "null" } ], "description": "The schema for the callback request body" }, "output_schema": { "$ref": "#/components/schemas/ToolResponseBody-Input", "description": "The schema for the callback response body" } }, "type": "object", "required": [ "callback_url", "method", "output_schema" ], "title": "CallbackBinding", "description": "A binding for a tool that uses a callback URL." }, "CallbackBinding-Output": { "properties": { "callback_url": { "type": "string", "title": "Callback Url", "description": "The URL to send the callback to" }, "method": { "$ref": "#/components/schemas/HTTP_METHOD", "description": "The HTTP method to use for the callback" }, "input_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolRequestBody-Output" }, { "type": "null" } ], "description": "The schema for the callback request body" }, "output_schema": { "$ref": "#/components/schemas/ToolResponseBody-Output", "description": "The schema for the callback response body" } }, "type": "object", "required": [ "callback_url", "method", "output_schema" ], "title": "CallbackBinding", "description": "A binding for a tool that uses a callback URL." }, "CatalogExport": { "properties": { "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" }, "assistants": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/CustomAssistantOut" }, { "$ref": "#/components/schemas/WatsonAssistantOut" } ] }, "type": "array" }, { "type": "null" } ], "title": "Assistants" }, "models": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ModelOut" }, "type": "array" }, { "type": "null" } ], "title": "Models" }, "document_collections": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DocumentCollection" }, "type": "array" }, { "type": "null" } ], "title": "Document Collections" }, "vector_indices": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VectorIndex" }, "type": "array" }, { "type": "null" } ], "title": "Vector Indices" } }, "type": "object", "required": [ "metadata" ], "title": "CatalogExport" }, "CatalogExportRequest": { "properties": { "resource_types": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CatalogResourceType" }, "type": "array" }, { "type": "null" } ], "title": "Resource Types" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" } }, "type": "object", "title": "CatalogExportRequest" }, "CatalogResourceType": { "type": "string", "enum": [ "__all__", "assistant", "model", "document_collection", "document", "vector_index" ], "title": "CatalogResourceType" }, "CatalogSkillResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "artifact_id of the skill" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "description of the skill" }, "name": { "type": "string", "title": "Name", "description": "name of the skill" }, "visibility": { "type": "boolean", "title": "Visibility", "description": "visibility of the skill" }, "state": { "type": "string", "title": "State", "description": "state of the skill" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id", "description": "artifact group id of the skill belong to" }, "catalog_ref_id": { "type": "string", "title": "Catalog Ref Id", "description": "skill_id of the skill" }, "createdAt": { "type": "string", "title": "Createdat", "description": "createdAt of the skill" }, "updatedAt": { "type": "string", "title": "Updatedat", "description": "updatedAt of the skill" }, "is_added": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Added", "description": "if the skill is aded to the archer already", "default": false } }, "type": "object", "required": [ "id", "description", "name", "visibility", "state", "group_id", "catalog_ref_id", "createdAt", "updatedAt" ], "title": "CatalogSkillResponse" }, "ChatCompletion": { "properties": { "messages": { "items": { "$ref": "#/components/schemas/CreateMessageV2" }, "type": "array", "title": "Messages" }, "additional_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Additional Parameters" }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context", "description": "Optional context dictionary" }, "stream": { "type": "boolean", "title": "Stream", "default": true } }, "type": "object", "required": [ "messages" ], "title": "ChatCompletion" }, "ChatCompletionRequest": { "properties": { "model": { "type": "string", "title": "Model" }, "messages": { "items": { "$ref": "#/components/schemas/ChatMessage" }, "type": "array", "title": "Messages" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty", "default": 0.0 }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty", "default": 0.0 }, "logit_bias": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature", "default": 1.0 }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N", "default": 1 }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "stop": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream", "default": false }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P", "default": 1.0 }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Tool" }, "type": "array" }, { "type": "null" } ], "title": "Tools" }, "tool_choice": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Choice", "default": "auto" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "extra_model_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extra Model Args" } }, "type": "object", "required": [ "model", "messages" ], "title": "ChatCompletionRequest" }, "ChatCompletionResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "object": { "type": "string", "title": "Object" }, "created": { "type": "integer", "title": "Created" }, "model": { "type": "string", "title": "Model" }, "choices": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Choices" }, "thread_id": { "type": "string", "format": "uuid", "title": "Thread Id" } }, "type": "object", "required": [ "id", "object", "created", "model", "choices", "thread_id" ], "title": "ChatCompletionResponse" }, "ChatMessage": { "properties": { "role": { "type": "string", "title": "Role" }, "content": { "type": "string", "title": "Content" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "role", "content" ], "title": "ChatMessage" }, "ChatWithDocsConfig-Input": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "description": "Controls if the Chat with Documents feature is enabled for this agent", "default": false }, "supports_full_document": { "type": "boolean", "title": "Supports Full Document", "description": "Controls if the Agent can request to use the full document. Only used if generation.enabled = false", "default": true }, "vector_index": { "$ref": "#/components/schemas/KnowledgeBaseBuiltInVectorIndexConfig" }, "generation": { "$ref": "#/components/schemas/GenerationConfiguration" }, "query_rewrite": { "$ref": "#/components/schemas/QueryRewriteConfig" }, "confidence_thresholds": { "$ref": "#/components/schemas/ConfidenceThresholds" }, "citations": { "$ref": "#/components/schemas/CitationsConfig" }, "hap_filtering": { "$ref": "#/components/schemas/HAPFiltering" }, "query_source": { "$ref": "#/components/schemas/QuerySource", "default": "Agent" }, "agent_query_description": { "type": "string", "title": "Agent Query Description", "default": "The query to search for in the knowledge base" } }, "type": "object", "title": "ChatWithDocsConfig" }, "ChatWithDocsConfig-Output": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "description": "Controls if the Chat with Documents feature is enabled for this agent", "default": false }, "supports_full_document": { "type": "boolean", "title": "Supports Full Document", "description": "Controls if the Agent can request to use the full document. Only used if generation.enabled = false", "default": true }, "vector_index": { "$ref": "#/components/schemas/KnowledgeBaseBuiltInVectorIndexConfig" }, "generation": { "$ref": "#/components/schemas/GenerationConfiguration" }, "query_rewrite": { "$ref": "#/components/schemas/QueryRewriteConfig" }, "confidence_thresholds": { "$ref": "#/components/schemas/ConfidenceThresholds" }, "citations": { "$ref": "#/components/schemas/CitationsConfig" }, "hap_filtering": { "$ref": "#/components/schemas/HAPFiltering" }, "query_source": { "$ref": "#/components/schemas/QuerySource", "default": "Agent" }, "agent_query_description": { "type": "string", "title": "Agent Query Description", "default": "The query to search for in the knowledge base" } }, "type": "object", "title": "ChatWithDocsConfig" }, "CitationsConfig": { "properties": { "citation_title": { "type": "string", "title": "Citation Title", "default": "How do we know?" }, "citations_shown": { "type": "integer", "title": "Citations Shown", "default": -1 } }, "type": "object", "title": "CitationsConfig", "description": "example:\n{\n \"citation_title\": \"how do i know\",\n \"citations_shown\": 5,\n}" }, "ClientSideToolBinding": { "properties": {}, "type": "object", "title": "ClientSideToolBinding", "description": "A binding for a tool that is executed on the client side." }, "CompletionRequest": { "properties": { "model": { "type": "string", "title": "Model" }, "prompt": { "type": "string", "title": "Prompt" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty", "default": 0.0 }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty", "default": 0.0 }, "logit_bias": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Logprobs" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature", "default": 1.0 }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N", "default": 1 }, "best_of": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Of", "default": 1 }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "stop": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream", "default": false }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens", "default": 16 }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P", "default": 1.0 }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "suffix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Suffix" }, "extra_model_args": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Extra Model Args" } }, "type": "object", "required": [ "model", "prompt" ], "title": "CompletionRequest" }, "CompletionResponse": { "properties": { "content": { "type": "string", "title": "Content" }, "response_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Response Metadata" } }, "type": "object", "required": [ "content" ], "title": "CompletionResponse" }, "ConfidenceThresholds": { "properties": { "retrieval_confidence_threshold": { "$ref": "#/components/schemas/RetrievalConfidenceThreshold", "default": "Lowest" }, "response_confidence_threshold": { "$ref": "#/components/schemas/ResponseConfidenceThreshold", "default": "Lowest" } }, "type": "object", "title": "ConfidenceThresholds" }, "ConnectionOut": { "properties": { "appid": { "type": "string", "title": "Appid" }, "shared": { "type": "boolean", "title": "Shared" }, "tenant_id": { "type": "string", "title": "Tenant Id" }, "is_connected": { "type": "boolean", "title": "Is Connected" }, "connection_type": { "type": "string", "title": "Connection Type" }, "connection_id": { "type": "string", "title": "Connection Id" } }, "type": "object", "required": [ "appid", "shared", "tenant_id", "is_connected", "connection_type", "connection_id" ], "title": "ConnectionOut" }, "ConnectionTypeEnum": { "type": "string", "enum": [ "basic_auth", "bearer_token", "api_key_auth", "oauth2_auth_code", "oauth2_implicit", "oauth2_password", "oauth2_client_creds", "key_value_creds" ], "title": "ConnectionTypeEnum" }, "Context": { "properties": { "values": { "items": { "$ref": "#/components/schemas/ContextKV" }, "type": "array", "title": "Values", "default": [] } }, "type": "object", "title": "Context" }, "ContextKV": { "properties": { "key": { "type": "string", "title": "Key" }, "value": { "title": "Value" } }, "type": "object", "required": [ "key" ], "title": "ContextKV" }, "ConversationalSearchConfig": { "properties": { "language": { "type": "string", "title": "Language", "default": "en" }, "index_config": { "items": { "$ref": "#/components/schemas/IndexConnection" }, "type": "array", "title": "Index Config" }, "generation": { "$ref": "#/components/schemas/GenerationConfiguration" }, "query_rewrite": { "$ref": "#/components/schemas/QueryRewriteConfig" }, "confidence_thresholds": { "$ref": "#/components/schemas/ConfidenceThresholds" }, "citations": { "$ref": "#/components/schemas/CitationsConfig" }, "hap_filtering": { "$ref": "#/components/schemas/HAPFiltering" }, "query_source": { "$ref": "#/components/schemas/QuerySource", "default": "SessionHistory" }, "agent_query_description": { "type": "string", "title": "Agent Query Description", "default": "The query to search for in the knowledge base" }, "supports_full_document": { "type": "boolean", "title": "Supports Full Document", "default": false } }, "type": "object", "title": "ConversationalSearchConfig" }, "ConversationalSearchToolBinding": { "properties": { "conversational_search_config": { "additionalProperties": true, "type": "object", "title": "Conversational Search Config" }, "connections": { "items": {}, "type": "array", "title": "Connections" }, "version": { "type": "string", "title": "Version", "default": "0.0.1" } }, "type": "object", "title": "ConversationalSearchToolBinding" }, "CreateAgent": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for the agent" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tool names available to the agent", "default": [] }, "collaborators": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Collaborators", "description": "List of other agent names this agent can collaborate with", "default": [] }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "LLM identifier for the agent" }, "style": { "$ref": "#/components/schemas/AgentStyle", "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "glossary": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Glossary", "description": "List of glossary available to the agent", "default": [] }, "guidelines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array" }, { "type": "null" } ], "title": "Guidelines", "description": "List of guidelines for the agent behavior", "default": [] }, "knowledge_base": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Base", "description": "List of knowledge_base available to the agent", "default": [] }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed", "default": false }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "custom_join_tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool ID that will be used for custom synthesis of task results" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalPropertiesIn" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "chat_with_docs": { "anyOf": [ { "$ref": "#/components/schemas/ChatWithDocsConfig-Input" }, { "type": "null" } ], "description": "Chat with Documents config for Agent" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] }, "hide_reasoning": { "type": "boolean", "title": "Hide Reasoning", "description": "Enable/disable reasoning trace", "default": false }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "restrictions": { "$ref": "#/components/schemas/AgentRestrictionsEnum", "description": "Enable editable for the collaborator agent", "default": "editable" }, "bundled_agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bundled Agent Id", "description": "Base agent id" }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig-Input" }, { "type": "null" } ] }, "agent_mapping": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Agent Mapping", "description": "agent_config available to the agent", "default": {} }, "icon": { "anyOf": [ { "$ref": "#/components/schemas/AgentSvgIcon" }, { "type": "null" } ], "description": "Catalog Agent Icon data" } }, "type": "object", "required": [ "description", "style" ], "title": "CreateAgent", "description": "Schema for creating a new agent derived from base." }, "CreateAgentFromTemplate": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Optional UUID for the agent" }, "name": { "type": "string", "title": "Name", "description": "Name of the agent" }, "category": { "type": "string", "title": "Category", "description": "Category of the agent" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "Version of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "spec": { "$ref": "#/components/schemas/CreateAgent", "description": "Agent specification" }, "dependencies": { "additionalProperties": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "type": "object", "title": "Dependencies", "description": "Dependencies including tools and agents" } }, "type": "object", "required": [ "name", "category", "description", "spec" ], "title": "CreateAgentFromTemplate", "description": "Schema for creating an agent from template." }, "CreateAttachedAgentConfig": { "properties": { "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id" }, "environment_id": { "type": "string", "format": "uuid", "title": "Environment Id" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name" }, "environment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Name" } }, "type": "object", "required": [ "agent_id", "environment_id" ], "title": "CreateAttachedAgentConfig" }, "CreateBatchTranscriptSegments": { "properties": { "segments": { "items": { "$ref": "#/components/schemas/CreateTranscriptSegment" }, "type": "array", "title": "Segments" } }, "type": "object", "required": [ "segments" ], "title": "CreateBatchTranscriptSegments" }, "CreateConnection": { "properties": { "appid": { "type": "string", "title": "Appid", "description": "Application ID or application name" }, "connection_type": { "$ref": "#/components/schemas/ConnectionTypeEnum", "description": "Type of connection" }, "credentials": { "additionalProperties": true, "type": "object", "title": "Credentials", "description": "Credentials as a JSON object" }, "shared": { "type": "boolean", "title": "Shared", "description": "Whether the connection is shared, default is true", "default": true } }, "type": "object", "required": [ "appid", "connection_type", "credentials" ], "title": "CreateConnection" }, "CreateCustomAssistant": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "instructions": { "type": "string", "title": "Instructions" }, "user_start_messages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "User Start Messages" }, "llm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Llm Id" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] } }, "type": "object", "required": [ "name", "instructions" ], "title": "CreateCustomAssistant" }, "CreateDocument": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "collection_id": { "type": "string", "format": "uuid", "title": "Collection Id" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "default": {} }, "source_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Uri" }, "source_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Source Date" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name" }, "source_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Title" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" } }, "type": "object", "required": [ "name", "collection_id" ], "title": "CreateDocument" }, "CreateDocumentCollection": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "CreateDocumentCollection" }, "CreateEnvironment": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the environment" }, "description": { "type": "string", "title": "Description", "description": "Description of what the environment does" }, "voice": { "anyOf": [ { "$ref": "#/components/schemas/Voice" }, { "type": "null" } ], "description": "Voice configuration for the environment" }, "current_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Version", "description": "Current agent version pointed to this environment" }, "enable_wxg_integration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Wxg Integration", "description": "Enable/disable WXG integration for this agent", "default": false } }, "type": "object", "required": [ "name", "description" ], "title": "CreateEnvironment", "description": "Schema for creating a new Environment." }, "CreateExternalChatAgent": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "api_url": { "type": "string", "title": "Api Url" }, "auth_scheme": { "$ref": "#/components/schemas/ExternalAgentAuthScheme", "default": "BEARER_TOKEN" }, "auth_config": { "additionalProperties": true, "type": "object", "title": "Auth Config", "default": {} }, "chat_params": { "additionalProperties": true, "type": "object", "title": "Chat Params", "default": {} }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/ExternalChatAgentConfig" }, { "type": "null" } ] }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "provider": { "type": "string", "title": "Provider", "default": "external_chat" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] } }, "type": "object", "required": [ "api_url" ], "title": "CreateExternalChatAgent" }, "CreateFacebookChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "facebook", "title": "Channel", "default": "facebook" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "application_secret": { "type": "string", "title": "Application Secret" }, "verification_token": { "type": "string", "title": "Verification Token" }, "page_access_token": { "type": "string", "title": "Page Access Token" } }, "type": "object", "required": [ "application_secret", "verification_token", "page_access_token" ], "title": "CreateFacebookChannel" }, "CreateGenesysAudioConnectorChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "genesys_audio_connector", "title": "Channel", "default": "genesys_audio_connector" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "api_key": { "type": "string", "title": "Api Key" } }, "type": "object", "required": [ "api_key" ], "title": "CreateGenesysAudioConnectorChannel" }, "CreateGenesysBotConnectorChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "genesys_bot_connector", "title": "Channel", "default": "genesys_bot_connector" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_id": { "type": "string", "title": "Client Id" }, "client_secret": { "type": "string", "title": "Client Secret" }, "verification_token": { "type": "string", "title": "Verification Token" }, "api_url": { "type": "string", "title": "Api Url" }, "bot_connector_id": { "type": "string", "title": "Bot Connector Id" } }, "type": "object", "required": [ "client_id", "client_secret", "verification_token", "api_url", "bot_connector_id" ], "title": "CreateGenesysBotConnectorChannel" }, "CreateMessage": { "properties": { "role": { "type": "string", "title": "Role" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AssistantContent" }, "type": "array" }, { "type": "string" } ], "title": "Content" }, "mentions": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/Mention" }, { "$ref": "#/components/schemas/AssistantMention" } ] }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "parent_message_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Message Id" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AdditionalProperties" }, { "type": "null" } ] }, "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "context": { "anyOf": [ { "$ref": "#/components/schemas/Context" }, { "type": "null" } ] }, "step_history": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Step History" }, "message_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Message State" } }, "type": "object", "required": [ "role", "content" ], "title": "CreateMessage" }, "CreateMessageV2": { "properties": { "role": { "type": "string", "title": "Role" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AssistantContent" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Content" } }, "type": "object", "required": [ "role", "content" ], "title": "CreateMessageV2" }, "CreateModelConfig": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "type": "string", "title": "Display Name" }, "policy": { "$ref": "#/components/schemas/FullModelConfig-Input" } }, "type": "object", "required": [ "name", "description", "display_name", "policy" ], "title": "CreateModelConfig" }, "CreateModelInput": { "properties": { "name": { "type": "string", "title": "Name" }, "display_name": { "type": "string", "title": "Display Name" }, "provider_config": { "$ref": "#/components/schemas/Options" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig-Input" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "model_type": { "$ref": "#/components/schemas/wo_archer__schema__models__ModelType", "default": "chat" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" } }, "type": "object", "required": [ "name", "display_name", "provider_config" ], "title": "CreateModelInput" }, "CreateNotification": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "thread_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Thread Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "CreateNotification" }, "CreatePhoneConfig": { "properties": { "name": { "type": "string", "maxLength": 64, "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "service_provider": { "$ref": "#/components/schemas/ServiceProvider", "default": "sip_trunk" }, "custom_invite_headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CustomInviteHeader" }, "type": "array" }, { "type": "null" } ], "title": "Custom Invite Headers", "default": [] }, "put_caller_on_hold_on_transfer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Put Caller On Hold On Transfer", "default": true }, "send_provisional_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Send Provisional Response", "default": true }, "security": { "$ref": "#/components/schemas/PhoneSecurity" }, "error_handling": { "$ref": "#/components/schemas/PhoneErrorHandling", "default": {} } }, "type": "object", "required": [ "name", "security" ], "title": "CreatePhoneConfig" }, "CreatePhoneNumberConfig": { "properties": { "phone_number": { "type": "string", "title": "Phone Number" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" } }, "type": "object", "required": [ "phone_number" ], "title": "CreatePhoneNumberConfig" }, "CreatePolicyResponse": { "properties": { "success": { "type": "boolean", "title": "Success" }, "added": { "type": "integer", "title": "Added" }, "failed": { "type": "integer", "title": "Failed" }, "results": { "additionalProperties": { "$ref": "#/components/schemas/ServicePolicyResponse" }, "type": "object", "title": "Results" } }, "type": "object", "required": [ "success", "added", "failed", "results" ], "title": "CreatePolicyResponse" }, "CreatePrompt": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "title": { "type": "string", "title": "Title" }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtitle" }, "prompt": { "type": "string", "title": "Prompt" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "type": "object", "required": [ "title", "prompt" ], "title": "CreatePrompt" }, "CreateRule": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "entity_value": { "type": "string", "title": "Entity Value" } }, "type": "object", "required": [ "policy", "entity_value" ], "title": "CreateRule" }, "CreateSlackApp": { "properties": { "channel": { "type": "string", "title": "Channel" }, "app_id": { "type": "string", "title": "App Id" }, "client_id": { "type": "string", "title": "Client Id" }, "client_secret": { "type": "string", "title": "Client Secret" }, "signing_secret": { "type": "string", "title": "Signing Secret" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" } }, "type": "object", "required": [ "channel", "app_id", "client_id", "client_secret", "signing_secret" ], "title": "CreateSlackApp" }, "CreateSlackChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "byo_slack", "title": "Channel", "default": "byo_slack" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_id": { "type": "string", "title": "Client Id" }, "client_secret": { "type": "string", "title": "Client Secret" }, "signing_secret": { "type": "string", "title": "Signing Secret" }, "teams": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SlackTeam" }, "type": "array" }, { "type": "null" } ], "title": "Teams" } }, "type": "object", "required": [ "client_id", "client_secret", "signing_secret" ], "title": "CreateSlackChannel" }, "CreateTeamsChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "teams", "title": "Channel", "default": "teams" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "app_password": { "type": "string", "title": "App Password" }, "app_id": { "type": "string", "title": "App Id" }, "teams_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Teams Tenant Id" } }, "type": "object", "required": [ "app_password", "app_id" ], "title": "CreateTeamsChannel" }, "CreateTenant": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/Settings-Input" }, { "type": "null" } ] } }, "type": "object", "required": [ "name" ], "title": "CreateTenant" }, "CreateThread": { "properties": { "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "title": { "type": "string", "title": "Title", "description": "title of the thread", "default": "Untitled" }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" } }, "type": "object", "title": "CreateThread" }, "CreateTool": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the tool" }, "description": { "type": "string", "title": "Description" }, "permission": { "$ref": "#/components/schemas/ToolPermission" }, "input_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolRequestBody-Input" }, { "type": "null" } ] }, "output_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolResponseBody-Input" }, { "type": "null" } ] }, "binding": { "anyOf": [ { "$ref": "#/components/schemas/ToolBinding-Input" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "is_async": { "type": "boolean", "title": "Is Async", "description": "Whether the tool execution is asynchronous", "default": false }, "restrictions": { "type": "string", "title": "Restrictions", "description": "Whether the tool can be edited", "default": "editable" }, "bundled_agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bundled Agent Id", "description": "Base agent id" } }, "type": "object", "required": [ "description", "permission" ], "title": "CreateTool", "description": "A specification for a tool that can be used in an agent." }, "CreateToolFromTemplate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "category": { "type": "string", "title": "Category" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" }, "spec": { "$ref": "#/components/schemas/CreateTool" }, "attachments": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Attachments" } }, "type": "object", "required": [ "name", "description", "category", "spec" ], "title": "CreateToolFromTemplate" }, "CreateToolKit": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the toolkit" }, "description": { "type": "string", "title": "Description", "description": "Optional description of the toolkit" }, "mcp": { "$ref": "#/components/schemas/MCPToolKitConfig", "description": "Optional MCP configuration. Required only if tools are imported from MCP." } }, "type": "object", "required": [ "name", "description" ], "title": "CreateToolKit", "description": "A specification for a toolkit which comprises of tools" }, "CreateTranscriptSegment": { "properties": { "recorded_at": { "type": "string", "format": "date-time", "title": "Recorded At" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" }, "source": { "$ref": "#/components/schemas/SourceType" }, "segment_type": { "$ref": "#/components/schemas/SegmentType" }, "seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seq" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "customer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Name" }, "processing_mode": { "anyOf": [ { "$ref": "#/components/schemas/ProcessingMode" }, { "type": "null" } ] }, "nlp": { "anyOf": [ { "$ref": "#/components/schemas/SegmentNLP" }, { "type": "null" } ] }, "conversation_id": { "type": "string", "maxLength": 64, "minLength": 8, "pattern": "^[a-zA-Z0-9_-]+$", "title": "Conversation Id" } }, "type": "object", "required": [ "recorded_at", "source", "segment_type", "conversation_id" ], "title": "CreateTranscriptSegment" }, "CreateTranscriptSegmentRequest": { "properties": { "recorded_at": { "type": "string", "format": "date-time", "title": "Recorded At" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" }, "source": { "$ref": "#/components/schemas/SourceType" }, "segment_type": { "$ref": "#/components/schemas/SegmentType" }, "seq": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seq" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string", "maxLength": 64, "minLength": 1, "pattern": "^[a-zA-Z0-9_.-]+$" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "customer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer Name" }, "processing_mode": { "anyOf": [ { "$ref": "#/components/schemas/ProcessingMode" }, { "type": "null" } ] }, "nlp": { "anyOf": [ { "$ref": "#/components/schemas/SegmentNLP" }, { "type": "null" } ] } }, "type": "object", "required": [ "recorded_at", "source", "segment_type" ], "title": "CreateTranscriptSegmentRequest" }, "CreateTwilioSMSChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "twilio_sms", "title": "Channel", "default": "twilio_sms" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "account_sid": { "type": "string", "title": "Account Sid" }, "twilio_authentication_token": { "type": "string", "title": "Twilio Authentication Token" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" } }, "type": "object", "required": [ "account_sid", "twilio_authentication_token" ], "title": "CreateTwilioSMSChannel" }, "CreateTwilioWhatsappChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "twilio_whatsapp", "title": "Channel", "default": "twilio_whatsapp" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "account_sid": { "type": "string", "title": "Account Sid" }, "twilio_authentication_token": { "type": "string", "title": "Twilio Authentication Token" } }, "type": "object", "required": [ "account_sid", "twilio_authentication_token" ], "title": "CreateTwilioWhatsappChannel" }, "CreateVectorIndex": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "embeddings_model_name": { "type": "string", "title": "Embeddings Model Name" }, "chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Size", "default": 400 }, "chunk_overlap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Overlap", "default": 20 }, "top_k": { "type": "integer", "title": "Top K", "default": 10 }, "extraction_strategy": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "standard" } }, "type": "object", "required": [ "name", "embeddings_model_name" ], "title": "CreateVectorIndex" }, "CreateVoiceConfiguration": { "properties": { "name": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Name" }, "llm_aggregation_timeout_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Llm Aggregation Timeout Seconds", "description": "Maximum time to wait for additional transcription content before pushing aggregated result.", "default": 0.8 }, "speech_to_text": { "$ref": "#/components/schemas/SpeechToTextConfig" }, "text_to_speech": { "$ref": "#/components/schemas/TextToSpeechConfig" }, "language": { "type": "string", "maxLength": 16, "minLength": 2, "title": "Language", "description": "Default language code, e.g., 'en-us'", "default": "en-us" }, "additional_languages": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/LanguageVoiceConfig" }, "type": "object" }, { "type": "null" } ], "title": "Additional Languages", "description": "Additional language configurations keyed by language code" }, "dtmf_input": { "anyOf": [ { "$ref": "#/components/schemas/DTMFInputConfig" }, { "type": "null" } ] }, "vad": { "anyOf": [ { "$ref": "#/components/schemas/VADConfig" }, { "type": "null" } ] }, "user_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/UserIdleHandlerConfig" }, { "type": "null" } ] }, "agent_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/AgentIdleHandler" }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "speech_to_text", "text_to_speech" ], "title": "CreateVoiceConfiguration" }, "CustomAssistantOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "type": { "type": "string", "title": "Type" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "user_start_messages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "User Start Messages" }, "llm_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm Name" }, "llm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Llm Id" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] } }, "type": "object", "required": [ "type" ], "title": "CustomAssistantOut" }, "CustomInviteHeader": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "CustomInviteHeader" }, "CustomSearchConnection": { "properties": { "url": { "type": "string", "title": "Url" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" } }, "type": "object", "required": [ "url" ], "title": "CustomSearchConnection", "description": "example:\n\n{\n \"url\": \"https://customsearch.xxxx.us-east.codeengine.appdomain.cloud\",\n \"filter\": \"...\",\n \"metadata\": {...}\n}" }, "DTMFInputConfig": { "properties": { "inter_digit_timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inter Digit Timeout Ms", "description": "The amount of time (ms) to wait for a new DTMF digit, default is 2500 ms.", "default": 2500 }, "termination_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Termination Key", "description": "The DTMF termination key that signals the end of DTMF input." }, "maximum_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Count", "description": "Maximum number of digits a user can enter." }, "ignore_speech": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ignore Speech", "description": "Disable speech recognition during collection of DTMF digits, default is true.", "default": true } }, "type": "object", "title": "DTMFInputConfig" }, "DataType": { "type": "string", "enum": [ "collection", "table" ], "title": "DataType" }, "DecodingMethod": { "type": "string", "enum": [ "greedy", "sample" ], "title": "DecodingMethod" }, "DeepgramSTTConfig": { "properties": { "api_url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Api Url", "description": "Deepgram API URL" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key", "description": "Deepgram API key" }, "model": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Model", "description": "Deepgram model name, e.g., 'nova-3'" }, "keyterm": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keyterm", "description": "Key terms to boost recognition of" }, "mip_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mip Opt Out", "description": "Opt out of model improvement program" }, "channels": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Channels", "description": "Number of audio channels" }, "diarize": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Diarize", "description": "Enable speaker diarization" }, "dictation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dictation", "description": "Enable dictation mode" }, "endpointing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Endpointing", "description": "Endpointing silence duration in seconds, or false to disable" }, "extra": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra", "description": "Extra parameters to pass to Deepgram" }, "interim_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Interim Results", "description": "Enable interim results" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "Keywords to detect" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "BCP-47 language tag" }, "multichannel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Multichannel", "description": "Transcribe each audio channel independently" }, "numerals": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Numerals", "description": "Convert numbers from written to numerical form" }, "profanity_filter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profanity Filter", "description": "Filter profanity" }, "punctuate": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Punctuate", "description": "Add punctuation and capitalization" }, "redact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Redact", "description": "Redact sensitive information" }, "replace": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Replace", "description": "Replace specified terms" }, "search": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Search", "description": "Search for specific terms" }, "smart_format": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smart Format", "description": "Apply smart formatting to the transcript" }, "tag": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag", "description": "Tag for the request" }, "utterance_end_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Utterance End Ms", "description": "How long Deepgram will wait to send UtteranceEnd message after word has been transcribed" }, "vad_events": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Vad Events", "description": "Enable Deepgram's voice activity detection events" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "API version" }, "eager_eot_threshold": { "anyOf": [ { "type": "number", "maximum": 0.9, "minimum": 0.3 }, { "type": "null" } ], "title": "Eager Eot Threshold", "description": "End-of-turn confidence required to fire an eager EOT event, between (0.3 - 0.9)" }, "eot_threshold": { "anyOf": [ { "type": "number", "maximum": 0.9, "minimum": 0.5 }, { "type": "null" } ], "title": "Eot Threshold", "description": "End-of-turn confidence required to finish a turn, between (0.5 - 0.9)" }, "eot_timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Eot Timeout Ms", "description": "A turn will be finished when this much time (ms) has passed after speech, regardless of EOT confidence" } }, "type": "object", "required": [ "api_url", "api_key", "model" ], "title": "DeepgramSTTConfig" }, "DeepgramTTSConfig": { "properties": { "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key", "description": "Deepgram API key." }, "mip_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mip Opt Out", "description": "Opt out of model improvement program." }, "model": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Model", "description": "The ID (canonical name) of the Deepgram model to use." }, "language": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Language", "description": "An optional UI indicator to help the UI show different languages." } }, "type": "object", "required": [ "api_key" ], "title": "DeepgramTTSConfig" }, "DefaultModelParams": { "properties": { "max_new_tokens": { "type": "integer", "title": "Max New Tokens" }, "min_new_tokens": { "type": "integer", "title": "Min New Tokens" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Tokens" } }, "type": "object", "required": [ "max_new_tokens", "min_new_tokens", "max_output_tokens" ], "title": "DefaultModelParams" }, "DeletePolicyRequest": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" } }, "type": "object", "required": [ "ids" ], "title": "DeletePolicyRequest" }, "DisplayProperties": { "properties": { "skip_render": { "type": "boolean", "title": "Skip Render", "default": false }, "is_async": { "type": "boolean", "title": "Is Async", "default": false }, "form_operation": { "type": "string", "title": "Form Operation", "default": "" } }, "type": "object", "title": "DisplayProperties" }, "DocumentCollection": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "DocumentCollection" }, "DocumentCollectionOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "DocumentCollectionOut" }, "DocumentCollectionPatch": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "DocumentCollectionPatch" }, "DocumentOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "default": {} }, "source_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Uri" }, "source_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Source Date" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name" }, "source_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Title" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "collection_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Collection Id" }, "collection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Collection Name" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" } }, "type": "object", "title": "DocumentOut" }, "DocumentPatch": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "default": {} }, "source_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Uri" }, "source_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Source Date" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name" }, "source_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Title" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" } }, "type": "object", "title": "DocumentPatch" }, "ESCredentialsOut": { "properties": { "host": { "type": "string", "title": "Host" } }, "type": "object", "required": [ "host" ], "title": "ESCredentialsOut" }, "EditAppRequest": { "properties": { "hidden": { "type": "boolean", "title": "Hidden", "description": "is hidden flag" } }, "type": "object", "required": [ "hidden" ], "title": "EditAppRequest" }, "EditRoutingDescriptionRequest": { "properties": { "routing_description": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Routing Description", "description": "Routing description for the artifact" } }, "type": "object", "required": [ "routing_description" ], "title": "EditRoutingDescriptionRequest" }, "ElasticSearchConnection": { "properties": { "url": { "type": "string", "title": "Url" }, "index": { "type": "string", "title": "Index" }, "port": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Port" }, "query_body": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Query Body" }, "result_filter": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Result Filter" }, "field_mapping": { "$ref": "#/components/schemas/FieldMapping" } }, "type": "object", "required": [ "url", "index" ], "title": "ElasticSearchConnection", "description": "example:\n\n{\n \"url\": \"https://xxxx.databases.appdomain.cloud\",\n \"index\": \"search-wa-docs\",\n \"port\": \"31871\",\n \"query_body\": {\"size\":5,\"query\":{\"text_expansion\":{\"ml.tokens\":{\"model_id\":\".elser_model_2_linux-x86_64\",\"model_text\": \"$QUERY\"}}}},\n \"result_filter\": [\n {\n \"match\": {\n \"title\": \"A_keyword_in_title\"\n }\n },\n {\n \"match\": {\n \"text\": \"A_keyword_in_text\"\n }\n },\n {\n \"match\": {\n \"id\": \"A_specific_ID\"\n }\n }\n ],\n \"field_mapping\": {\n \"title\": \"title\",\n \"body\": \"text\",\n \"url\": \"some-url\"\n }\n}" }, "ElevenLabsPronounciationDict": { "properties": { "pronunciation_dictionary_id": { "type": "string", "title": "Pronunciation Dictionary Id", "description": "ID of the pronunciation dictionary" }, "version_id": { "type": "string", "title": "Version Id", "description": "Version ID of the pronunciation dictionary" } }, "type": "object", "required": [ "pronunciation_dictionary_id", "version_id" ], "title": "ElevenLabsPronounciationDict" }, "ElevenLabsTTSConfig": { "properties": { "model_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Model Id", "description": "The ID of the ElevenLabs model to use" }, "voice_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Voice Id", "description": "The ID of the ElevenLabs voice to use" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key", "description": "ElevenLabs API key" }, "apply_text_normalization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Apply Text Normalization", "description": "Whether to apply text normalization" }, "language_code": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 2 }, { "type": "null" } ], "title": "Language Code", "description": "Language code for the voice, e.g., 'en', 'es'" }, "optimize_streaming_latency": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Optimize Streaming Latency", "description": "Optimize streaming latency (0-4)" }, "apply_language_text_normalization": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply Language Text Normalization", "description": "Whether to apply language-specific text normalization" }, "pronunciation_dictionary_locators": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ElevenLabsPronounciationDict" }, "type": "array" }, { "type": "null" } ], "title": "Pronunciation Dictionary Locators", "description": "List of pronunciation dictionary locators" }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed", "description": "Seed for deterministic audio generation" }, "previous_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Text", "description": "Previous text for context" }, "next_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Text", "description": "Next text for context" }, "voice_settings": { "anyOf": [ { "$ref": "#/components/schemas/ElevenLabsVoiceSettings" }, { "type": "null" } ], "description": "Voice settings for the ElevenLabs TTS" } }, "type": "object", "required": [ "model_id", "voice_id", "api_key" ], "title": "ElevenLabsTTSConfig" }, "ElevenLabsVoiceSettings": { "properties": { "speed": { "type": "number", "title": "Speed", "description": "Speech speed. Defaults to 1.0", "default": 1.0 }, "style": { "type": "number", "title": "Style", "description": "Style exaggeration: the higher the value, the more computational resources are used. Defaults to 0.0", "default": 0.0 }, "stability": { "type": "number", "title": "Stability", "description": "Stability: how stable the voice is and the randomness between each generation. Defaults to 0.5", "default": 0.5 }, "similarity_boost": { "type": "number", "title": "Similarity Boost", "description": "Similarity boost: how closely the AI should adhere to the original voice. Defaults to 0.75", "default": 0.75 }, "use_speaker_boost": { "type": "boolean", "title": "Use Speaker Boost", "description": "Whether to use speaker boost. Defaults to true", "default": true } }, "type": "object", "title": "ElevenLabsVoiceSettings" }, "EmbeddedChatConfigIn": { "properties": { "layout": { "anyOf": [ { "$ref": "#/components/schemas/LayoutConfig-Input" }, { "type": "null" } ], "description": "Layout configuration" }, "is_live": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Live", "description": "Status of the embedded chat script" } }, "type": "object", "title": "EmbeddedChatConfigIn", "description": "Spec for embedded chat config in." }, "EmbeddedChatConfigOut": { "properties": { "layout": { "anyOf": [ { "$ref": "#/components/schemas/LayoutConfig-Output" }, { "type": "null" } ], "description": "Layout configuration" }, "is_live": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Live", "description": "Status of the embedded chat script" }, "script": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Script", "description": "Generated embedded chat script" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At", "description": "Last update timestamp" } }, "type": "object", "title": "EmbeddedChatConfigOut", "description": "Spec for embedded chat config out." }, "EmbeddedChatConfigResponse": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string" } ], "title": "Id", "description": "Unique identifier for the agent or no_agent for UI get" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this agent" }, "embedded_chat_config": { "$ref": "#/components/schemas/EmbeddedChatConfigOut", "description": "Embedded chat configuration" } }, "type": "object", "required": [ "id", "tenant_id", "embedded_chat_config" ], "title": "EmbeddedChatConfigResponse", "description": "Response model for embedded chat configuration." }, "EmbeddingMode": { "type": "string", "enum": [ "server", "client" ], "title": "EmbeddingMode" }, "EmbeddingsModelSettings": { "properties": { "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name", "description": "Name of the model to use for embeddings. Must be a valid model name available on watsonx.ai." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id", "description": "The ID of a custom configured model to use for embeddings." } }, "additionalProperties": false, "type": "object", "title": "EmbeddingsModelSettings" }, "EmotechSTTConfig": { "properties": { "api_url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "positive_speech_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Positive Speech Threshold", "description": "Confidence threshold above which audio is classified as speech, default is 0.25", "default": 0.25 }, "negative_speech_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Negative Speech Threshold", "description": "Confidence threshold below which audio is classified as non-speech, default is 0.25", "default": 0.25 }, "partial_interval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partial Interval", "description": "Time interval (in ms) between partial transcription results, default is 500 ms.", "default": 500 }, "silence_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Silence Threshold", "description": "Silence duration (in ms) after speech used to determine end of utterance, default is 1500 ms.", "default": 500 } }, "type": "object", "required": [ "api_url" ], "title": "EmotechSTTConfig" }, "EmotechTTSConfig": { "properties": { "api_url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "voice": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Voice" } }, "type": "object", "required": [ "api_url" ], "title": "EmotechTTSConfig" }, "Environment": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Environment id From The environment table" }, "agent_id": { "type": "string", "format": "uuid", "title": "Agent Id", "description": "Agent id From The environment table" }, "name": { "type": "string", "title": "Name", "description": "Name of the environment" }, "description": { "type": "string", "title": "Description", "description": "Description of what the environment does" }, "voice": { "anyOf": [ { "$ref": "#/components/schemas/Voice" }, { "type": "null" } ], "description": "Voice configuration for the environment" }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user who created the environment" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "updated_by": { "type": "string", "title": "Updated By", "description": "ID of the user who updated the environment" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Last update timestamp" }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "current_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Version", "description": "Current agent version pointed to this environment" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this environment" }, "enable_wxg_integration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Wxg Integration", "description": "Enable/disable WXG integration for this agent", "default": false } }, "type": "object", "required": [ "id", "agent_id", "name", "description", "created_by", "created_on", "updated_by", "updated_at", "tenant_id" ], "title": "Environment" }, "EnvironmentSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the environment" }, "name": { "type": "string", "title": "Name", "description": "Name of the environment" }, "current_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Version", "description": "current_version" }, "voice": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Voice", "description": "Voice configuration for the environment" }, "enable_wxg_integration": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Enable Wxg Integration", "description": "Flag to enable/disable wxg integration", "default": "inactive" }, "wxg_metrics_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wxg Metrics Url", "description": "URL to watsonx.governance metrics dashboard for this agent", "default": "" } }, "type": "object", "required": [ "id", "name" ], "title": "EnvironmentSchema", "description": "Schema for simplified environment within an agent." }, "EvaluateTestcasesRequest": { "properties": { "test_case_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Test Case Ids" } }, "type": "object", "required": [ "test_case_ids" ], "title": "EvaluateTestcasesRequest" }, "EvaluateTestcasesResponse": { "properties": { "evaluation_id": { "type": "string", "format": "uuid", "title": "Evaluation Id", "description": "Evaluation ID" }, "number_of_test_cases": { "type": "integer", "title": "Number Of Test Cases", "description": "Number of test cases" } }, "type": "object", "required": [ "evaluation_id", "number_of_test_cases" ], "title": "EvaluateTestcasesResponse" }, "EvaluationListResponse": { "properties": { "total": { "type": "integer", "title": "Total", "description": "Total number of evaluations" }, "page": { "type": "integer", "title": "Page", "description": "Current page" }, "page_size": { "type": "integer", "title": "Page Size", "description": "Number of results per page" }, "evaluations": { "items": { "$ref": "#/components/schemas/EvaluationResponse" }, "type": "array", "title": "Evaluations", "description": "List of evaluations in this page" } }, "type": "object", "required": [ "total", "page", "page_size", "evaluations" ], "title": "EvaluationListResponse" }, "EvaluationMetrics": { "properties": { "tool_quality": { "anyOf": [ { "$ref": "#/components/schemas/ToolQualityMetrics" }, { "type": "null" } ] }, "answer_quality": { "anyOf": [ { "$ref": "#/components/schemas/AnswerQualityMetrics" }, { "type": "null" } ] }, "transaction_completion": { "anyOf": [ { "$ref": "#/components/schemas/TrasactionCompletionMetrics" }, { "type": "null" } ] } }, "type": "object", "title": "EvaluationMetrics" }, "EvaluationResponse": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id", "description": "Evaluation ID" }, "executed_date": { "type": "string", "title": "Executed Date", "description": "Date evaluated" }, "evaluation_status": { "anyOf": [ { "$ref": "#/components/schemas/StatusEnum" }, { "type": "null" } ], "description": "Evaluation status" }, "number_of_test_cases": { "type": "integer", "title": "Number Of Test Cases", "description": "Number of test cases" }, "executed_by": { "type": "string", "title": "Executed By", "description": "Run by user" }, "aggregate_metrices": { "anyOf": [ { "$ref": "#/components/schemas/EvaluationMetrics" }, { "type": "null" } ], "description": "Aggregated metrics" }, "agent_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Name", "description": "Name of the agent" }, "agent_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Description", "description": "Description of the agent" }, "agent_environment": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array" }, { "type": "null" } ], "title": "Agent Environment", "description": "List of environments associated with the agent", "default": [] } }, "type": "object", "required": [ "executed_date", "evaluation_status", "number_of_test_cases", "executed_by" ], "title": "EvaluationResponse" }, "EvaluationSortKey": { "type": "string", "enum": [ "executed_date", "number_of_test_cases", "executed_by" ], "title": "EvaluationSortKey" }, "EvaluationStatusResponse": { "properties": { "is_running": { "type": "boolean", "title": "Is Running", "description": "Whether any evaluation is currently running" }, "evaluation_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Evaluation Id", "description": "ID of the running evaluation if any" } }, "type": "object", "required": [ "is_running" ], "title": "EvaluationStatusResponse" }, "EvaluationTestCaseResponse": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id", "description": "Test case ID" }, "prompt": { "type": "string", "title": "Prompt", "description": "Prompt text" }, "status": { "$ref": "#/components/schemas/TestCaseStatusEnum", "description": "Test case status" }, "created_date": { "type": "string", "format": "date-time", "title": "Created Date", "description": "Created date" }, "executed_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Executed Date", "description": "Last executed date" } }, "type": "object", "required": [ "prompt", "status", "created_date" ], "title": "EvaluationTestCaseResponse" }, "EvaluationTestCasesFilter": { "type": "string", "enum": [ "IN_PROGRESS", "PASSED", "FAILED" ], "title": "EvaluationTestCasesFilter" }, "EvaluationTestCasesListResponse": { "properties": { "total": { "type": "integer", "title": "Total", "description": "Total number of test cases" }, "page": { "type": "integer", "title": "Page", "description": "Current page" }, "page_size": { "type": "integer", "title": "Page Size", "description": "Number of results per page" }, "test_cases": { "items": { "$ref": "#/components/schemas/EvaluationTestCaseResponse" }, "type": "array", "title": "Test Cases", "description": "List of test cases in this page" } }, "type": "object", "required": [ "total", "page", "page_size", "test_cases" ], "title": "EvaluationTestCasesListResponse" }, "EventRequest": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id" }, "event_type": { "type": "string", "title": "Event Type" } }, "type": "object", "required": [ "tenant_id", "event_type" ], "title": "EventRequest" }, "EventType": { "type": "string", "enum": [ "run.started", "run.completed", "run.failed", "run.expired", "run.cancelled", "run.step.started", "run.step.completed", "run.step.failed", "run.step.delta", "message.created", "message.started", "message.delta", "message.completed", "run.step.thinking", "message.interrupt", "transcription", "summary", "error", "done", "planning", "flow.slot.listen" ], "title": "EventType" }, "Examples": { "properties": { "input": { "title": "Input" }, "output": { "title": "Output" } }, "type": "object", "required": [ "input", "output" ], "title": "Examples" }, "ExportEvaluationRequest": { "properties": { "evaluation_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Evaluation Ids" } }, "type": "object", "required": [ "evaluation_ids" ], "title": "ExportEvaluationRequest" }, "ExternalAgentAuthScheme": { "type": "string", "enum": [ "BEARER_TOKEN", "API_KEY", "NONE" ], "title": "ExternalAgentAuthScheme" }, "ExternalChatAgent": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "title": "Type" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "hidden": { "type": "boolean", "title": "Hidden", "default": false }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access" }, "api_url": { "type": "string", "title": "Api Url" }, "auth_scheme": { "$ref": "#/components/schemas/ExternalAgentAuthScheme", "default": "BEARER_TOKEN" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "auth_config": { "additionalProperties": true, "type": "object", "title": "Auth Config", "default": {} }, "chat_params": { "additionalProperties": true, "type": "object", "title": "Chat Params", "default": {} }, "enable_cot": { "type": "boolean", "title": "Enable Cot", "default": false }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" } }, "type": "object", "required": [ "name", "type", "api_url" ], "title": "ExternalChatAgent" }, "ExternalChatAgentConfig": { "properties": { "hidden": { "type": "boolean", "title": "Hidden", "default": false }, "enable_cot": { "type": "boolean", "title": "Enable Cot", "default": false } }, "type": "object", "title": "ExternalChatAgentConfig" }, "ExtractionStrategy": { "type": "string", "enum": [ "express", "standard", "high_quality" ], "title": "ExtractionStrategy" }, "FieldMapping": { "properties": { "title": { "type": "string", "title": "Title", "default": "title" }, "body": { "type": "string", "title": "Body", "default": "text" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "type": "object", "title": "FieldMapping", "description": "example\n\n{\n \"title\": \"title\",\n \"body\": \"text\",\n \"url\": \"some-url\"\n}" }, "FlexibleProperty-Input": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, { "additionalProperties": true, "type": "object" } ], "title": "FlexibleProperty" }, "FlexibleProperty-Output": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, { "additionalProperties": true, "type": "object" } ], "title": "FlexibleProperty" }, "FlowDependencies": { "properties": { "tools": { "items": { "type": "string" }, "type": "array", "title": "Tools", "default": [] }, "agents": { "items": { "type": "string" }, "type": "array", "title": "Agents", "default": [] } }, "type": "object", "title": "FlowDependencies", "description": "Tools and agents dependencies of a flow tool" }, "FlowToolBinding-Input": { "properties": { "http_method": { "anyOf": [ { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, { "type": "null" } ], "title": "Http Method" }, "http_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Http Path" }, "security": { "items": { "$ref": "#/components/schemas/OpenApiSecurityScheme" }, "type": "array", "title": "Security", "default": [] }, "servers": { "items": { "type": "string" }, "type": "array", "title": "Servers", "default": [] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "callback": { "anyOf": [ { "$ref": "#/components/schemas/CallbackBinding-Input" }, { "type": "null" } ] }, "acknowledgement": { "anyOf": [ { "$ref": "#/components/schemas/AcknowledgementResponseBody-Input" }, { "type": "null" } ] }, "flow_id": { "type": "string", "title": "Flow Id", "description": "The ID of the flow to call.", "default": "" }, "version": { "type": "string", "title": "Version", "description": "The version of the flow to call.", "default": "TIP" }, "dependencies": { "anyOf": [ { "$ref": "#/components/schemas/FlowDependencies" }, { "type": "null" } ], "description": "The dependencies of the flow." }, "model": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model", "description": "The flow model to be used to generate an OpenAPI spec. This won't be stored." } }, "type": "object", "title": "FlowToolBinding", "description": "A binding for a tool that uses a flow.\nA flow tool is called as an OpenAPI tool." }, "FlowToolBinding-Output": { "properties": { "http_method": { "anyOf": [ { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, { "type": "null" } ], "title": "Http Method" }, "http_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Http Path" }, "security": { "items": { "$ref": "#/components/schemas/OpenApiSecurityScheme" }, "type": "array", "title": "Security", "default": [] }, "servers": { "items": { "type": "string" }, "type": "array", "title": "Servers", "default": [] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "callback": { "anyOf": [ { "$ref": "#/components/schemas/CallbackBinding-Output" }, { "type": "null" } ] }, "acknowledgement": { "anyOf": [ { "$ref": "#/components/schemas/AcknowledgementResponseBody-Output" }, { "type": "null" } ] }, "flow_id": { "type": "string", "title": "Flow Id", "description": "The ID of the flow to call.", "default": "" }, "version": { "type": "string", "title": "Version", "description": "The version of the flow to call.", "default": "TIP" }, "dependencies": { "anyOf": [ { "$ref": "#/components/schemas/FlowDependencies" }, { "type": "null" } ], "description": "The dependencies of the flow." }, "model": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model", "description": "The flow model to be used to generate an OpenAPI spec. This won't be stored." } }, "type": "object", "title": "FlowToolBinding", "description": "A binding for a tool that uses a flow.\nA flow tool is called as an OpenAPI tool." }, "FormConfig": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Type of the form (fullscreen-overlay, float, etc.)" }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/FormProperties" }, { "type": "null" } ], "description": "Properties of the form" } }, "type": "object", "title": "FormConfig", "description": "Configuration for the embedded chat form." }, "FormProperties": { "properties": { "container_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Container Id", "description": "ID of the container element" }, "width": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Width", "description": "Width of the chat container" }, "height": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Height", "description": "Height of the chat container" } }, "type": "object", "title": "FormProperties", "description": "Properties for the embedded chat form." }, "FullModelConfig-Input": { "properties": { "strategy": { "$ref": "#/components/schemas/StrategyConfig" }, "cache": { "anyOf": [ { "$ref": "#/components/schemas/CacheConfig" }, { "type": "null" } ] }, "retry": { "anyOf": [ { "$ref": "#/components/schemas/RetryConfig" }, { "type": "null" } ] }, "targets": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TargetConfig" }, { "$ref": "#/components/schemas/NestedStrategy-Input" } ] }, "type": "array", "title": "Targets" } }, "type": "object", "required": [ "strategy", "targets" ], "title": "FullModelConfig" }, "FullModelConfig-Output": { "properties": { "strategy": { "$ref": "#/components/schemas/StrategyConfig" }, "cache": { "anyOf": [ { "$ref": "#/components/schemas/CacheConfig" }, { "type": "null" } ] }, "retry": { "anyOf": [ { "$ref": "#/components/schemas/RetryConfig" }, { "type": "null" } ] }, "targets": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TargetConfig" }, { "$ref": "#/components/schemas/NestedStrategy-Output" } ] }, "type": "array", "title": "Targets" } }, "type": "object", "required": [ "strategy", "targets" ], "title": "FullModelConfig" }, "Function": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Parameters", "default": {} } }, "type": "object", "required": [ "name" ], "title": "Function" }, "GeneratedResponseLength": { "type": "string", "enum": [ "Concise", "Moderate", "Verbose" ], "title": "GeneratedResponseLength" }, "GenerationConfiguration": { "properties": { "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" }, "prompt_instruction": { "type": "string", "title": "Prompt Instruction", "default": "" }, "max_docs_passed_to_llm": { "type": "integer", "title": "Max Docs Passed To Llm", "default": 5 }, "generated_response_length": { "$ref": "#/components/schemas/GeneratedResponseLength", "default": "Moderate" }, "display_text_no_results_found": { "type": "string", "title": "Display Text No Results Found", "default": "I searched my knowledge base, but did not find anything related to your query" }, "display_text_connectivity_issue": { "type": "string", "title": "Display Text Connectivity Issue", "default": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment" }, "idk_message": { "type": "string", "title": "Idk Message", "default": "I'm afraid I don't understand. Please rephrase your question." }, "enabled": { "type": "boolean", "title": "Enabled", "default": false } }, "type": "object", "title": "GenerationConfiguration", "description": "example\n{\n \"model_id\": \"meta-llama/llama-3-1-70b-instruct\",\n \"prompt_instruction\": \"When the documents are in different languages, you should respond in english.\",\n \"max_docs_passed_to_llm\": 5,\n \"retrieval_confidence_threshold\": \"Lowest\",\n \"generated_response_length\": \"Moderate\",\n \"response_confidence_threshold\": \"Low\",\n \"display_text_no_results_found\": \"no docs found\",\n \"display_text_connectivity_issue\": \"conn failed\",\n}" }, "GroupedArtifactResponse": { "properties": { "id": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Id", "description": "Primary keys of the artifact group", "default": [] }, "catalog_ref_id": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ], "title": "Catalog Ref Id", "description": "Application Id / Catalog Ref. Id" }, "group_name": { "type": "string", "minLength": 1, "title": "Group Name", "description": "Name of the artifact group" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the artifact group" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "Icon associated with the artifact group" } }, "type": "object", "required": [ "catalog_ref_id", "group_name", "description" ], "title": "GroupedArtifactResponse" }, "Guardrail": { "properties": { "input": { "anyOf": [ { "$ref": "#/components/schemas/GuardrailConfig" }, { "type": "null" } ] }, "output": { "anyOf": [ { "$ref": "#/components/schemas/GuardrailConfig" }, { "type": "null" } ] }, "mask": { "anyOf": [ { "$ref": "#/components/schemas/MaskProperties" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "Guardrail" }, "GuardrailConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "threshold": { "type": "number", "title": "Threshold", "default": 0.5 } }, "additionalProperties": false, "type": "object", "title": "GuardrailConfig" }, "Guardrails-Input": { "properties": { "hap": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] }, "social_bias": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] }, "pii": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "Guardrails" }, "Guardrails-Output": { "properties": { "hap": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] }, "social_bias": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] }, "pii": { "anyOf": [ { "$ref": "#/components/schemas/Guardrail" }, { "type": "null" } ] } }, "additionalProperties": false, "type": "object", "title": "Guardrails" }, "Guideline": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the guideline" }, "condition": { "type": "string", "title": "Condition", "description": "Condition when the guideline should be applied" }, "action": { "type": "string", "title": "Action", "description": "Action to take when the condition is met" }, "tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool", "description": "The tool id use for this guideline" } }, "type": "object", "required": [ "condition", "action" ], "title": "Guideline", "description": "Schema for an agent guideline." }, "HAPFiltering": { "properties": { "output": { "$ref": "#/components/schemas/HAPFilteringConfig" } }, "type": "object", "title": "HAPFiltering", "description": "example\n{\n \"output\": {\n \"enabled\": True,\n \"threshold\": 0.7,\n }\n}" }, "HAPFilteringConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": false }, "threshold": { "type": "number", "title": "Threshold", "default": 0.5 } }, "type": "object", "title": "HAPFilteringConfig" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HTTP_METHOD": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "title": "HTTP_METHOD", "description": "HTTP methods supported for callbacks." }, "IndexConnection": { "properties": { "connection_id": { "type": "string", "title": "Connection Id" }, "milvus": { "anyOf": [ { "$ref": "#/components/schemas/MilvusConnection" }, { "type": "null" } ] }, "elastic_search": { "anyOf": [ { "$ref": "#/components/schemas/ElasticSearchConnection" }, { "type": "null" } ] }, "custom_search": { "anyOf": [ { "$ref": "#/components/schemas/CustomSearchConnection" }, { "type": "null" } ] }, "astradb": { "anyOf": [ { "$ref": "#/components/schemas/AstraDBConnection" }, { "type": "null" } ] } }, "type": "object", "title": "IndexConnection" }, "IntegrationsInput": { "properties": { "public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key" }, "client_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Public Key" }, "is_security_enabled": { "type": "boolean", "title": "Is Security Enabled", "default": false } }, "type": "object", "title": "IntegrationsInput" }, "IntegrationsOut": { "properties": { "orchestrate_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orchestrate Id" }, "client_public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Public Key" }, "public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "is_security_enabled": { "type": "boolean", "title": "Is Security Enabled", "default": false } }, "type": "object", "title": "IntegrationsOut" }, "JourneyRepresentation": { "properties": { "id": { "type": "string", "title": "Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "examples": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "journey_type": { "anyOf": [ { "$ref": "#/components/schemas/JourneyType" }, { "type": "null" } ] } }, "type": "object", "required": [ "id" ], "title": "JourneyRepresentation" }, "JourneyType": { "type": "string", "enum": [ "custom_assistant", "watson_assistant" ], "title": "JourneyType" }, "JsonSchemaObject-Input": { "properties": { "type": { "type": "string", "enum": [ "object", "string", "number", "integer", "boolean", "array", "null" ], "title": "Type", "default": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required" }, "items": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, { "type": "null" } ] }, "default": { "anyOf": [ {}, { "type": "null" } ], "title": "Default" }, "enum": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Enum" }, "minimum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Minimum" }, "maximum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maximum" }, "minLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minlength" }, "maxLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxlength" }, "pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pattern" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "in": { "anyOf": [ { "type": "string", "enum": [ "query", "header", "path", "body" ] }, { "type": "null" } ], "title": "In" }, "aliasName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Aliasname" }, "anyOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Anyof" }, "oneOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Oneof" }, "allOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Allof" } }, "type": "object", "title": "JsonSchemaObject", "description": "A JSON Schema object that defines the structure and validation rules for JSON data." }, "JsonSchemaObject-Output": { "properties": { "type": { "type": "string", "enum": [ "object", "string", "number", "integer", "boolean", "array", "null" ], "title": "Type", "default": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required" }, "items": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, { "type": "null" } ] }, "default": { "anyOf": [ {}, { "type": "null" } ], "title": "Default" }, "enum": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Enum" }, "minimum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Minimum" }, "maximum": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Maximum" }, "minLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Minlength" }, "maxLength": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maxlength" }, "pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pattern" }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "in": { "anyOf": [ { "type": "string", "enum": [ "query", "header", "path", "body" ] }, { "type": "null" } ], "title": "In" }, "aliasName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Aliasname" }, "anyOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Anyof" }, "oneOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Oneof" }, "allOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Allof" } }, "type": "object", "title": "JsonSchemaObject", "description": "A JSON Schema object that defines the structure and validation rules for JSON data." }, "KeyPairOut": { "properties": { "orchestrate_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orchestrate Id" }, "public_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Key" }, "is_security_enabled": { "type": "boolean", "title": "Is Security Enabled", "default": false } }, "type": "object", "title": "KeyPairOut" }, "KnowledgeBaseBuiltInVectorIndexConfig": { "properties": { "embeddings_model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embeddings Model Name" }, "chunk_size": { "type": "integer", "title": "Chunk Size", "default": 400 }, "chunk_overlap": { "type": "integer", "title": "Chunk Overlap", "default": 50 }, "limit": { "type": "integer", "title": "Limit", "default": 10 }, "extraction_strategy": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "standard" } }, "type": "object", "title": "KnowledgeBaseBuiltInVectorIndexConfig" }, "KnowledgeBaseRepresentation": { "type": "string", "enum": [ "auto", "tool" ], "title": "KnowledgeBaseRepresentation" }, "KnowledgeBasesResponseWithPagination": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ListKnowledgeBase" }, "type": "array", "title": "Data" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "result_count": { "type": "integer", "title": "Result Count" } }, "type": "object", "required": [ "data", "total", "limit", "offset", "result_count" ], "title": "KnowledgeBasesResponseWithPagination" }, "LLMAnalyticsGetResponse": { "properties": { "active": { "type": "boolean", "title": "Active", "default": false }, "mask_pii": { "type": "boolean", "title": "Mask Pii", "default": false }, "host_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host Uri" }, "config_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config Json" } }, "type": "object", "title": "LLMAnalyticsGetResponse", "description": "Response model for GET request" }, "LLMAnalyticsIntegrationRequest": { "properties": { "project_id": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Project Id", "description": "Project ID, defaults to 'default'", "default": "default" }, "tool_identifier": { "type": "string", "title": "Tool Identifier", "description": "Identifier for the analytics tool" }, "api_key": { "type": "string", "minLength": 10, "title": "Api Key", "description": "API Key for the tool" }, "host_uri": { "type": "string", "title": "Host Uri", "description": "Host URI for the analytics tool" }, "host_health_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Host Health Uri", "description": "Health check URI" }, "mask_pii": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mask Pii", "description": "Flag to mask PII", "default": false }, "config_json": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config Json", "description": "Additional configuration" } }, "additionalProperties": false, "type": "object", "required": [ "tool_identifier", "api_key", "host_uri" ], "title": "LLMAnalyticsIntegrationRequest" }, "LLMAnalyticsSuccessResponse": { "properties": { "status": { "type": "string", "title": "Status", "default": "Transaction completed successfully" } }, "type": "object", "title": "LLMAnalyticsSuccessResponse", "description": "Standard success response for PUT and DELETE operations" }, "LangflowToolBinding": { "properties": { "langflow_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Langflow Id", "description": "The ID of langflow that is binded" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id", "description": "The ID of project in which Langflow is created" }, "langflow_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Langflow Version", "description": "The version of the Langflow tool binded" }, "connections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Connections", "description": "details of the credential connections of the Langflow tool" } }, "type": "object", "title": "LangflowToolBinding", "description": "A binding for a tool that uses Langflow." }, "LanguageVoiceConfig": { "properties": { "text_to_speech": { "anyOf": [ { "$ref": "#/components/schemas/TextToSpeechConfig" }, { "type": "null" } ] }, "speech_to_text": { "anyOf": [ { "$ref": "#/components/schemas/SpeechToTextConfig" }, { "type": "null" } ] }, "user_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/UserIdleHandlerLangConfig" }, { "type": "null" } ] }, "agent_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/AgentIdleHandlerMessages" }, { "type": "null" } ] } }, "type": "object", "title": "LanguageVoiceConfig", "description": "Voice configuration for a specific language" }, "LayoutConfig-Input": { "properties": { "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Color", "description": "Primary color in hex format" }, "second_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Second Color", "description": "Secondary color in hex format" }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accent Color", "description": "Accent color in hex format" }, "theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Theme", "description": "Theme (light or dark)" }, "enable_text_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Text Streaming", "description": "Whether to enable text streaming" }, "form": { "anyOf": [ { "$ref": "#/components/schemas/FormConfig" }, { "type": "null" } ], "description": "Form configuration" } }, "type": "object", "title": "LayoutConfig", "description": "Layout configuration for embedded chat." }, "LayoutConfig-Output": { "properties": { "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Primary Color", "description": "Primary color in hex format" }, "second_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Second Color", "description": "Secondary color in hex format" }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accent Color", "description": "Accent color in hex format" }, "theme": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Theme", "description": "Theme (light or dark)" }, "enable_text_streaming": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Text Streaming", "description": "Whether to enable text streaming" }, "form": { "anyOf": [ { "$ref": "#/components/schemas/FormConfig" }, { "type": "null" } ], "description": "Form configuration" } }, "type": "object", "title": "LayoutConfig", "description": "Layout configuration for embedded chat." }, "LengthPenalty": { "properties": { "decay_factor": { "anyOf": [ { "type": "number", "exclusiveMinimum": 1.0 }, { "type": "null" } ], "title": "Decay factor" }, "start_index": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Start index" } }, "additionalProperties": true, "type": "object", "title": "LengthPenalty" }, "Lifecycle": { "properties": { "id": { "type": "string", "title": "Id" }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Date" } }, "type": "object", "required": [ "id" ], "title": "Lifecycle" }, "ListAgent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the agent" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this agent" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id", "description": "ID of the workspace that owns this agent", "default": "00000000-0000-0000-0000-000000000001" }, "name": { "type": "string", "title": "Name", "description": "Name of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for the agent" }, "tools": { "items": { "type": "string" }, "type": "array", "title": "Tools", "description": "List of tool names available to the agent" }, "collaborators": { "items": { "type": "string" }, "type": "array", "title": "Collaborators", "description": "List of other agent names this agent can collaborate with" }, "knowledge_base": { "items": { "type": "string" }, "type": "array", "title": "Knowledge Base", "default": [] }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "LLM identifier for the agent" }, "style": { "$ref": "#/components/schemas/AgentStyle", "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user who created the agent" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "updated_by": { "type": "string", "title": "Updated By", "description": "ID of the user who updated the agent" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Last update timestamp" }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "environments": { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array", "title": "Environments", "description": "List of simplified environments associated with the agent", "default": [] }, "agent_mapping": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Agent Mapping" }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "custom_join_tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool that will be used for custom synthesis of task results" }, "guidelines": { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array", "title": "Guidelines", "description": "List of guidelines for the agent behavior", "default": [] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "chat_with_docs": { "$ref": "#/components/schemas/ChatWithDocsConfig", "description": "Chat with Documents config for Agent" }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "voice_webhook_connections": { "anyOf": [ { "additionalProperties": { "items": { "$ref": "#/components/schemas/VoiceWebhookConnection" }, "type": "array" }, "type": "object" }, { "type": "null" } ], "title": "Voice Webhook Connections", "description": "Voice webhook connections organized by environment (draft/live)" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalProperties" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "connection_ids": { "items": { "type": "string" }, "type": "array", "title": "Connection Ids", "description": "List of connection IDs for direct agent-to-connection bindings", "default": [] }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] }, "hide_reasoning": { "type": "boolean", "title": "Hide Reasoning", "description": "Enable/disable reasoning trace", "default": false }, "sync_tool_flow_interactions": { "type": "boolean", "title": "Sync Tool Flow Interactions", "description": "Enable/disable syncing user interactions from tool flow to the agent", "default": true }, "restrictions": { "type": "string", "title": "Restrictions", "description": "Enable editable for the colloborator agent", "default": "editable" }, "bundled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bundled", "description": "Catalog Agent bundled flag", "default": false }, "bundled_agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bundled Agent Id", "description": "Base agent id" }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig" }, { "type": "null" } ] }, "plugins": { "anyOf": [ { "$ref": "#/components/schemas/Plugins" }, { "type": "null" } ], "description": "Plugins and hook points associated to the agents" }, "toolkits": { "items": { "type": "string" }, "type": "array", "title": "Toolkits", "description": "List of toolkit ids available to the agent" }, "memory_enabled": { "type": "boolean", "title": "Memory Enabled", "description": "Enable/disable agentic memory for this agent", "default": false }, "is_schedulable": { "type": "boolean", "title": "Is Schedulable", "description": "Indicates whether this agent can be scheduled for tasks", "default": false }, "custom_agents_metadata": { "anyOf": [ { "$ref": "#/components/schemas/CustomAgentsMetadata" }, { "type": "null" } ], "description": "Metadata for custom agents" }, "deleted_semantic_versions": { "items": { "type": "string" }, "type": "array", "title": "Deleted Semantic Versions", "description": "Track deleted semantic versions to prevent reuse (V2 API)", "default": [] } }, "type": "object", "required": [ "id", "tenant_id", "name", "description", "style", "created_by", "created_on", "updated_by", "updated_at" ], "title": "ListAgent", "description": "Schema for fetching agent." }, "ListAgentVersion": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the agent" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this agent" }, "name": { "type": "string", "title": "Name", "description": "Name of the agent" }, "description": { "type": "string", "title": "Description", "description": "Description of what the agent does" }, "version_label": { "type": "integer", "title": "Version Label", "description": "Version of the deployed agent" }, "semantic_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Semantic Version", "description": "Semantic version (e.g., 1.2.0)" }, "version_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Name", "description": "Human-readable version name" }, "version_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Description", "description": "Description of changes in this version" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Instructions for the agent" }, "tools": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array", "title": "Tools", "description": "List of tool names available to the agent" }, "collaborators": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array", "title": "Collaborators", "description": "List of other agent names this agent can collaborate with" }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "LLM identifier for the agent" }, "style": { "$ref": "#/components/schemas/AgentStyle", "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "points_to": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Points To", "description": "Environment IDs points to this version", "default": [] }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comments", "description": "Comments added by the user while deploying an agent" }, "mapped_environments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array" }, { "type": "null" } ], "title": "Mapped Environments", "description": "List of Environments points to the agent version", "default": [] }, "created_by": { "type": "string", "title": "Created By", "description": "ID of the user who created the agent" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "updated_by": { "type": "string", "title": "Updated By", "description": "ID of the user who updated the agent" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Last update timestamp" }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By" }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed", "default": false }, "environments": { "items": { "$ref": "#/components/schemas/EnvironmentSchema" }, "type": "array", "title": "Environments", "description": "List of simplified environments associated with the agent", "default": [] }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "knowledge_base": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Base", "description": "List of knowledge_base available to the agent", "default": [] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "guidelines": { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array", "title": "Guidelines", "description": "List of guidelines for the agent behavior", "default": [] }, "custom_join_tool": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool ID that will be used for custom synthesis of task results", "default": {} }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "deployment_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Status", "description": "V1 API: Single deployment status for backward compatibility" }, "deployment_statuses": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Deployment Statuses", "description": "V2 API: Per-environment deployment statuses {env_id: status}" }, "chat_with_docs": { "$ref": "#/components/schemas/ChatWithDocsConfig", "description": "Chat with Documents config for Agent" }, "connection_ids": { "items": { "type": "string" }, "type": "array", "title": "Connection Ids", "description": "List of connection IDs for direct agent-to-connection bindings", "default": [] }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalProperties" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] }, "hide_reasoning": { "type": "boolean", "title": "Hide Reasoning", "description": "Enable/disable reasoning trace", "default": false }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig" }, { "type": "null" } ] }, "plugins": { "anyOf": [ { "$ref": "#/components/schemas/Plugins" }, { "type": "null" } ], "description": "Plugins and hook points associated to the agent" }, "sync_tool_flow_interactions": { "type": "boolean", "title": "Sync Tool Flow Interactions", "description": "Enable/disable syncing user interactions from tool flow to the agent", "default": true }, "toolkits": { "items": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array", "title": "Toolkits", "description": "List of toolkits available to the agent" }, "memory_enabled": { "type": "boolean", "title": "Memory Enabled", "description": "Enable/disable agentic memory for this agent", "default": false } }, "type": "object", "required": [ "id", "tenant_id", "name", "description", "version_label", "style", "created_by", "created_on", "updated_by", "updated_at" ], "title": "ListAgentVersion", "description": "Schema for fetching list of agent version." }, "ListKnowledgeBase": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Unique identifier for the KB" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "ID of the tenant that owns this KB" }, "name": { "type": "string", "title": "Name", "description": "Name of the KB" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the KB" }, "description": { "type": "string", "title": "Description", "description": "Description of what the KB contains" }, "prioritize_built_in_index": { "type": "boolean", "title": "Prioritize Built In Index", "description": "prioritize built in vector index if both a built in index and external index is provided" }, "created_by": { "type": "string", "title": "Created By", "description": "Username of the user who created the KB" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Last update timestamp" }, "representation": { "$ref": "#/components/schemas/KnowledgeBaseRepresentation" }, "vector_index": { "$ref": "#/components/schemas/VectorIndexOut" }, "conversational_search_tool": { "anyOf": [ { "$ref": "#/components/schemas/ConversationalSearchConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "tenant_id", "name", "display_name", "description", "prioritize_built_in_index", "created_by", "updated_at", "representation", "vector_index", "conversational_search_tool" ], "title": "ListKnowledgeBase" }, "ListModelConfig": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "type": "string", "title": "Display Name" }, "policy": { "$ref": "#/components/schemas/FullModelConfig-Output" } }, "type": "object", "required": [ "id", "name", "description", "display_name", "policy" ], "title": "ListModelConfig" }, "ListModels": { "properties": { "resources": { "items": { "$ref": "#/components/schemas/Resources" }, "type": "array", "title": "Resources" } }, "type": "object", "required": [ "resources" ], "title": "ListModels" }, "MCPToolBinding": { "properties": { "server_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url", "description": "mcp server url to connect to" }, "source": { "anyOf": [ { "type": "string", "enum": [ "public-registry", "files" ] }, { "type": "null" } ], "title": "Source" }, "env": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Env", "description": "details of the envs to be set" }, "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Command", "description": "command to start the mcp server" }, "args": { "items": { "type": "string" }, "type": "array", "title": "Args", "description": "arguments to start the mcp server" }, "transport": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport", "description": "transport protocol of remote mcp" }, "connections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Connections", "description": "details of the credential connections of the Python tool" } }, "type": "object", "title": "MCPToolBinding", "description": "A binding for a tool that from MCP server." }, "MCPToolKitConfig": { "properties": { "source": { "anyOf": [ { "type": "string", "enum": [ "files", "public-registry" ] }, { "type": "null" } ], "title": "Source", "description": "Source of the MCP either file upload, github respository, or remote server" }, "server_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url", "description": "URL of the MCP server (if source is remote" }, "transport": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Transport", "description": "Transport protocol for remote MCP" }, "command": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Command", "description": "Command to start the MCP server" }, "args": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Args", "description": "Startup arguments for the MCP server" }, "env": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Env", "description": "Environment variables to be set" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string", "const": "*" }, { "type": "null" } ], "title": "Tools", "description": "List of tools to import from MCP. Use ['*'] to import all" }, "connections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Connections", "description": "details of the connections of the MCP toolkit" } }, "type": "object", "title": "MCPToolKitConfig" }, "MaskProperties": { "properties": { "remove_entity_value": { "type": "boolean", "title": "Remove Entity Value", "default": false } }, "additionalProperties": false, "type": "object", "title": "MaskProperties" }, "Mention": { "properties": { "type": { "type": "string", "title": "Type" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "type", "id", "name" ], "title": "Mention" }, "Message": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "type": "string", "title": "Tenant Id" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "thread_id": { "type": "string", "format": "uuid", "title": "Thread Id" }, "assistant": { "$ref": "#/components/schemas/AssistantInfo" }, "parent_message_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Message Id" }, "role": { "type": "string", "title": "Role" }, "content": { "items": { "$ref": "#/components/schemas/AssistantContent" }, "type": "array", "title": "Content" }, "mentions": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/Mention" }, { "$ref": "#/components/schemas/AssistantMention" } ] }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AdditionalProperties" }, { "type": "null" } ] }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "step_history": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Step History" }, "message_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Message State" } }, "type": "object", "required": [ "id", "tenant_id", "thread_id", "assistant", "role", "content" ], "title": "Message" }, "MetricDetail": { "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Value" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "MetricDetail" }, "MilvusConnection": { "properties": { "grpc_host": { "type": "string", "title": "Grpc Host" }, "grpc_port": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grpc Port" }, "server_cert": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Cert" }, "database": { "type": "string", "title": "Database" }, "collection": { "type": "string", "title": "Collection" }, "index": { "type": "string", "title": "Index" }, "embedding_model_id": { "type": "string", "title": "Embedding Model Id" }, "limit": { "type": "integer", "title": "Limit", "default": 10 }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" }, "field_mapping": { "$ref": "#/components/schemas/FieldMapping" } }, "type": "object", "required": [ "grpc_host", "database", "collection", "index", "embedding_model_id" ], "title": "MilvusConnection", "description": "example:\n{\n \"grpc_host\": \"https://xxxx.lakehouse.appdomain.cloud\",\n \"database\": \"test_db\",\n \"collection\": \"search_wa_docs\",\n \"index\": \"dense\",\n \"embedding_model_id\": \"sentence-transformers/all-minilm-l12-v2\",\n \"grpc_port\": \"30564\",\n \"filter\": \"title like \"%action%\"\",\n \"limit\": 10,\n \"field_mapping\": {\n \"title\": \"title\",\n \"body\": \"text\",\n \"url\": \"some-url\"\n }\n}" }, "Model": { "properties": { "model_name": { "type": "string", "title": "Model Name" }, "display_name": { "type": "string", "title": "Display Name" }, "model_params": { "anyOf": [ { "$ref": "#/components/schemas/ModelParams" }, { "type": "null" } ] }, "default_model_params": { "anyOf": [ { "$ref": "#/components/schemas/DefaultModelParams" }, { "type": "null" } ] }, "default": { "type": "boolean", "title": "Default" }, "tc_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tc Url", "default": "" }, "recommended": { "type": "boolean", "title": "Recommended", "default": false } }, "type": "object", "required": [ "model_name", "display_name", "default" ], "title": "Model" }, "ModelConfig-Input": { "properties": { "decoding_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decoding Method" }, "prompt": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Prompt" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "max_completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Completion Tokens" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream" }, "logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Logprobs" }, "top_logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Top Logprobs" }, "echo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Echo" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty" }, "best_of": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Of" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "examples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Examples" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top K" }, "response_format": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFormat" }, { "type": "null" } ] }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "store": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "modalities": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Modalities" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/AudioConfig" }, { "type": "null" } ] }, "service_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Tier" }, "prediction": { "anyOf": [ { "$ref": "#/components/schemas/Prediction" }, { "type": "null" } ] }, "safety_settings": { "anyOf": [ {}, { "type": "null" } ], "title": "Safety Settings" }, "anthropic_beta": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Beta" }, "anthropic_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Version" }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/Thinking" }, { "type": "null" } ] }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "reasoning_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Effort" } }, "additionalProperties": false, "type": "object", "title": "ModelConfig" }, "ModelConfig-Output": { "properties": { "decoding_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decoding Method" }, "prompt": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Prompt" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "max_completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Completion Tokens" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream" }, "logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Logprobs" }, "top_logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Top Logprobs" }, "echo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Echo" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty" }, "best_of": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Of" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "examples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Examples" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top K" }, "response_format": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFormat" }, { "type": "null" } ] }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "store": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "modalities": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Modalities" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/AudioConfig" }, { "type": "null" } ] }, "service_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Tier" }, "prediction": { "anyOf": [ { "$ref": "#/components/schemas/Prediction" }, { "type": "null" } ] }, "safety_settings": { "anyOf": [ {}, { "type": "null" } ], "title": "Safety Settings" }, "anthropic_beta": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Beta" }, "anthropic_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Version" }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/Thinking" }, { "type": "null" } ] }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "reasoning_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Effort" } }, "additionalProperties": false, "type": "object", "title": "ModelConfig" }, "ModelOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "model_type": { "$ref": "#/components/schemas/wo_archer__schema__models__ModelType", "default": "chat" }, "model_name": { "type": "string", "title": "Model Name" }, "api_base": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Base" }, "api_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Version" }, "deployment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deployment Id" }, "provider": { "anyOf": [ { "$ref": "#/components/schemas/ModelProvider" }, { "type": "null" } ] }, "config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Config" }, "provider_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Provider Config" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" } }, "type": "object", "required": [ "model_name" ], "title": "ModelOut" }, "ModelParams": { "properties": { "max_new_tokens": { "type": "integer", "title": "Max New Tokens" }, "min_new_tokens": { "type": "integer", "title": "Min New Tokens" } }, "type": "object", "required": [ "max_new_tokens", "min_new_tokens" ], "title": "ModelParams" }, "ModelProvider": { "type": "string", "enum": [ "openai", "anthropic", "azure-openai", "azure-ai", "anyscale", "cohere", "cerebras", "palm", "google", "together-ai", "mistral-ai", "perplexity-ai", "stability-ai", "nomic", "ollama", "bedrock", "ai21", "groq", "segmind", "vertex-ai", "deepinfra", "novita-ai", "fireworks-ai", "deepseek", "voyage", "vllm", "jina", "reka-ai", "moonshot", "openrouter", "lingyi", "zhipu", "monsterapi", "predibase", "huggingface", "github", "deepbricks", "siliconflow", "workers-ai", "ibm_bam", "watsonx", "mistralai", "specialized_routing_model", "product_rag", "x-ai" ], "title": "ModelProvider" }, "ModelSettings-Input": { "properties": { "base_llm": { "anyOf": [ { "$ref": "#/components/schemas/BaseLLMSettings-Input" }, { "type": "null" } ], "description": "The base LLM model used by Orchestrate. By default, Orchestrate will use the system configured base LLM." }, "embeddings": { "anyOf": [ { "$ref": "#/components/schemas/EmbeddingsModelSettings" }, { "type": "null" } ], "description": "The base embeddings model used by Orchestrate. By default, Orchestrate will use the system configured base embeddings model." }, "is_base_llm_enabled": { "type": "boolean", "title": "Is Base Llm Enabled", "description": "The is_base_llm_enabled flag is used to switch the route between LLM`s. By default the value for the flag will be False", "default": true } }, "additionalProperties": false, "type": "object", "title": "ModelSettings" }, "ModelSettings-Output": { "properties": { "base_llm": { "anyOf": [ { "$ref": "#/components/schemas/BaseLLMSettings-Output" }, { "type": "null" } ], "description": "The base LLM model used by Orchestrate. By default, Orchestrate will use the system configured base LLM." }, "embeddings": { "anyOf": [ { "$ref": "#/components/schemas/EmbeddingsModelSettings" }, { "type": "null" } ], "description": "The base embeddings model used by Orchestrate. By default, Orchestrate will use the system configured base embeddings model." }, "is_base_llm_enabled": { "type": "boolean", "title": "Is Base Llm Enabled", "description": "The is_base_llm_enabled flag is used to switch the route between LLM`s. By default the value for the flag will be False", "default": true } }, "additionalProperties": false, "type": "object", "title": "ModelSettings" }, "ModelUpdateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "provider_config": { "anyOf": [ { "$ref": "#/components/schemas/Options" }, { "type": "null" } ] }, "config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig-Input" }, { "type": "null" } ] }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" } }, "type": "object", "required": [ "name" ], "title": "ModelUpdateRequest" }, "MonitoringStatus": { "properties": { "wxg_service_instance_id": { "type": "string", "title": "Wxg Service Instance Id", "description": "Governance service instance id" } }, "type": "object", "required": [ "wxg_service_instance_id" ], "title": "MonitoringStatus" }, "NestedStrategy-Input": { "properties": { "strategy": { "$ref": "#/components/schemas/StrategyConfig" }, "targets": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TargetConfig" }, { "$ref": "#/components/schemas/NestedStrategy-Input" } ] }, "type": "array", "title": "Targets" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight" } }, "additionalProperties": true, "type": "object", "required": [ "strategy", "targets" ], "title": "NestedStrategy" }, "NestedStrategy-Output": { "properties": { "strategy": { "$ref": "#/components/schemas/StrategyConfig" }, "targets": { "items": { "anyOf": [ { "$ref": "#/components/schemas/TargetConfig" }, { "$ref": "#/components/schemas/NestedStrategy-Output" } ] }, "type": "array", "title": "Targets" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight" } }, "additionalProperties": true, "type": "object", "required": [ "strategy", "targets" ], "title": "NestedStrategy" }, "NotificationOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "thread_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Thread Id" }, "run_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Run Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "NotificationOut" }, "OpenApiSecurityScheme": { "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "apiKey", "http", "oauth2", "openIdConnect" ] }, { "type": "null" } ], "title": "Type" }, "scheme": { "anyOf": [ { "type": "string", "enum": [ "basic", "bearer", "oauth" ] }, { "type": "null" } ], "title": "Scheme" }, "in": { "anyOf": [ { "type": "string", "enum": [ "query", "header", "cookie" ] }, { "type": "null" } ], "title": "In" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "open_id_connect_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Open Id Connect Url", "default": "openIdConnectUrl" }, "flows": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Flows" } }, "type": "object", "title": "OpenApiSecurityScheme", "description": "A security scheme for an OpenAPI endpoint." }, "OpenApiToolBinding-Input": { "properties": { "http_method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "title": "Http Method" }, "http_path": { "type": "string", "title": "Http Path" }, "security": { "items": { "$ref": "#/components/schemas/OpenApiSecurityScheme" }, "type": "array", "title": "Security", "default": [] }, "servers": { "items": { "type": "string" }, "type": "array", "title": "Servers", "default": [] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "callback": { "anyOf": [ { "$ref": "#/components/schemas/CallbackBinding-Input" }, { "type": "null" } ] }, "acknowledgement": { "anyOf": [ { "$ref": "#/components/schemas/AcknowledgementResponseBody-Input" }, { "type": "null" } ] } }, "type": "object", "required": [ "http_method", "http_path" ], "title": "OpenApiToolBinding", "description": "A binding for a tool that uses an OpenAPI endpoint." }, "OpenApiToolBinding-Output": { "properties": { "http_method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "title": "Http Method" }, "http_path": { "type": "string", "title": "Http Path" }, "security": { "items": { "$ref": "#/components/schemas/OpenApiSecurityScheme" }, "type": "array", "title": "Security", "default": [] }, "servers": { "items": { "type": "string" }, "type": "array", "title": "Servers", "default": [] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "callback": { "anyOf": [ { "$ref": "#/components/schemas/CallbackBinding-Output" }, { "type": "null" } ] }, "acknowledgement": { "anyOf": [ { "$ref": "#/components/schemas/AcknowledgementResponseBody-Output" }, { "type": "null" } ] } }, "type": "object", "required": [ "http_method", "http_path" ], "title": "OpenApiToolBinding", "description": "A binding for a tool that uses an OpenAPI endpoint." }, "Options": { "properties": { "api_key": { "type": "string", "title": "Api Key", "default": "Dummy" }, "urlToFetch": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Urltofetch" }, "resourceName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resourcename" }, "deploymentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deploymentid" }, "apiVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Apiversion" }, "adAuth": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adauth" }, "azureAuthMode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureauthmode" }, "azureManagedClientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azuremanagedclientid" }, "azureEntraClientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureentraclientid" }, "azureEntraClientSecret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureentraclientsecret" }, "azureEntraTenantId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureentratenantid" }, "azureAdToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureadtoken" }, "azureModelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azuremodelname" }, "workersAiAccountId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workersaiaccountid" }, "customHost": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customhost" }, "forwardHeaders": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Forwardheaders" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index" }, "cache": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Cache" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "requestTimeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Requesttimeout" }, "transformToFormData": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Transformtoformdata" }, "awsSecretAccessKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awssecretaccesskey" }, "awsAccessKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsaccesskeyid" }, "awsSessionToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awssessiontoken" }, "awsRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsregion" }, "awsAuthType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsauthtype" }, "awsRoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsrolearn" }, "awsExternalId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsexternalid" }, "awsS3Bucket": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awss3Bucket" }, "awsS3ObjectKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awss3Objectkey" }, "awsBedrockModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsbedrockmodel" }, "awsServerSideEncryption": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsserversideencryption" }, "awsServerSideEncryptionKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Awsserversideencryptionkmskeyid" }, "amznSagemakerCustomAttributes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakercustomattributes" }, "amznSagemakerTargetModel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakertargetmodel" }, "amznSagemakerTargetVariant": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakertargetvariant" }, "amznSagemakerTargetContainerHostname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakertargetcontainerhostname" }, "amznSagemakerInferenceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakerinferenceid" }, "amznSagemakerEnableExplanations": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakerenableexplanations" }, "amznSagemakerInferenceComponent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakerinferencecomponent" }, "amznSagemakerSessionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakersessionid" }, "amznSagemakerModelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amznsagemakermodelname" }, "stabilityClientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stabilityclientid" }, "stabilityClientUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stabilityclientuserid" }, "stabilityClientVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stabilityclientversion" }, "huggingfaceBaseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Huggingfacebaseurl" }, "vertexRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vertexregion" }, "vertexProjectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vertexprojectid" }, "vertexServiceAccountJson": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Vertexserviceaccountjson" }, "vertexStorageBucketName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vertexstoragebucketname" }, "vertexModelName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Vertexmodelname" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "afterRequestHooks": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Afterrequesthooks" }, "beforeRequestHooks": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Beforerequesthooks" }, "defaultInputGuardrails": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Defaultinputguardrails" }, "defaultOutputGuardrails": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Defaultoutputguardrails" }, "openaiProject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Openaiproject" }, "openaiOrganization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Openaiorganization" }, "openaiBeta": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Openaibeta" }, "azureDeploymentName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azuredeploymentname" }, "azureApiVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureapiversion" }, "azureExtraParams": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azureextraparams" }, "azureFoundryUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Azurefoundryurl" }, "strictOpenAiCompliance": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strictopenaicompliance", "default": false }, "mistralFimCompletion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mistralfimcompletion" }, "anthropicBeta": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropicbeta" }, "anthropicVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropicversion" }, "fireworksAccountId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fireworksaccountid" }, "snowflakeAccount": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Snowflakeaccount" }, "watsonxVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxversion" }, "watsonxSpaceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxspaceid" }, "watsonxProjectId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxprojectid" }, "watsonxDeploymentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxdeploymentid" }, "watsonxCpdUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxcpdurl" }, "watsonxCpdUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxcpdusername" }, "watsonxCpdPassword": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Watsonxcpdpassword" } }, "additionalProperties": false, "type": "object", "title": "Options" }, "OutboundPolicyEnum": { "type": "string", "enum": [ "allow", "deny" ], "title": "OutboundPolicyEnum" }, "PaginatedAssistantRunResponse": { "properties": { "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "data": { "items": { "$ref": "#/components/schemas/AssistantRun" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "total", "limit", "offset", "data" ], "title": "PaginatedAssistantRunResponse" }, "PaginatedResponse_ArtifactGroup_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/ArtifactGroup" }, "type": "array", "title": "Items", "description": "List of items fetched in the current page" }, "total": { "type": "integer", "title": "Total", "description": "Total number of items available across all pages" }, "offset": { "type": "integer", "title": "Offset", "description": "The offset from which the items are fetched in the current page" }, "limit": { "type": "integer", "title": "Limit", "description": "Number of items to be fetched per page" } }, "type": "object", "required": [ "items", "total", "offset", "limit" ], "title": "PaginatedResponse[ArtifactGroup]" }, "PaginatedResponse_CatalogSkillResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/CatalogSkillResponse" }, "type": "array", "title": "Items", "description": "List of items fetched in the current page" }, "total": { "type": "integer", "title": "Total", "description": "Total number of items available across all pages" }, "offset": { "type": "integer", "title": "Offset", "description": "The offset from which the items are fetched in the current page" }, "limit": { "type": "integer", "title": "Limit", "description": "Number of items to be fetched per page" } }, "type": "object", "required": [ "items", "total", "offset", "limit" ], "title": "PaginatedResponse[CatalogSkillResponse]" }, "PaginatedResponse_SkillResponse_": { "properties": { "items": { "items": { "$ref": "#/components/schemas/SkillResponse" }, "type": "array", "title": "Items", "description": "List of items fetched in the current page" }, "total": { "type": "integer", "title": "Total", "description": "Total number of items available across all pages" }, "offset": { "type": "integer", "title": "Offset", "description": "The offset from which the items are fetched in the current page" }, "limit": { "type": "integer", "title": "Limit", "description": "Number of items to be fetched per page" } }, "type": "object", "required": [ "items", "total", "offset", "limit" ], "title": "PaginatedResponse[SkillResponse]" }, "PatchAgent": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Updated description" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions", "description": "Updated instructions" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "Updated list of tool names" }, "collaborators": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Collaborators", "description": "Updated list of collaborator names" }, "llm": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm", "description": "Updated LLM identifier" }, "style": { "anyOf": [ { "$ref": "#/components/schemas/AgentStyle" }, { "type": "null" } ], "description": "Style of the agent" }, "supported_apps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SupportedApp" }, "type": "array" }, { "type": "null" } ], "title": "Supported Apps", "description": "Supported apps of the agent" }, "glossary": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Glossary", "description": "List of glossary available to the agent", "default": [] }, "guidelines": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Guideline" }, "type": "array" }, { "type": "null" } ], "title": "Guidelines", "description": "List of guidelines for the agent behavior" }, "knowledge_base": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Knowledge Base", "description": "List of knowledge_base available to the agent", "default": [] }, "hidden": { "type": "boolean", "title": "Hidden", "description": "To show or hide agent when agents are listed" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "Display name of the agent" }, "structured_output": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Structured Output", "description": "JSON schema defining the structure for agent responses" }, "custom_join_tool": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Join Tool", "description": "Reference to a Python tool that will be used for custom synthesis of task results" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AgentAdditionalPropertiesIn" }, { "type": "null" } ], "description": "Agent Additional Settings" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags", "description": "List of tags associated to agent", "default": [] }, "voice_configuration_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Voice Configuration Id", "description": "Voice configuration for the agent" }, "chat_with_docs": { "anyOf": [ { "$ref": "#/components/schemas/ChatWithDocsConfig" }, { "type": "null" } ], "description": "Chat with Documents config for Agent" }, "context_access_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Context Access Enabled", "description": "Enable access to context variables for this agent" }, "connection_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Connection Ids", "description": "List of connection IDs for direct agent-to-connection bindings" }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access" }, "hide_reasoning": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hide Reasoning", "description": "Enable/disable reasoning trace" }, "workspace_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Workspace Id", "description": "ID of the workspace that owns this agent" }, "llm_config": { "anyOf": [ { "$ref": "#/components/schemas/ModelConfig" }, { "type": "null" } ] }, "plugins": { "anyOf": [ { "$ref": "#/components/schemas/Plugins" }, { "type": "null" } ], "description": "Plugins and hook points associated to the agents" }, "sync_tool_flow_interactions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sync Tool Flow Interactions", "description": "Enable/disable syncing user interactions from tool flow to the agent" }, "toolkits": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Toolkits", "description": "Updated list of toolkit ids" }, "memory_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Memory Enabled", "description": "Enable/disable agentic memory for this agent" }, "timeout_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timeout Seconds", "description": "Timeout in seconds for agent execution (min=120, max=900)", "max": 900, "min": 120 }, "custom_agents_metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Custom Agents Metadata", "description": "Metadata for custom agents (language, framework, tool count, tool names, connection requirements)" } }, "type": "object", "title": "PatchAgent", "description": "Schema for updating an existing agent." }, "PatchCustomAssistant": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "user_start_messages": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "User Start Messages" }, "llm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Llm Id" }, "context_access_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Context Access Enabled", "description": "Enable access to context variables for this agent" }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access" } }, "type": "object", "title": "PatchCustomAssistant" }, "PatchEnvironment": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the environment" }, "description": { "type": "string", "title": "Description", "description": "Description of what the environment does" }, "voice": { "anyOf": [ { "$ref": "#/components/schemas/Voice" }, { "type": "null" } ], "description": "Voice configuration for the environment" }, "current_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Current Version", "description": "Current agent version pointed to this environment" }, "enable_wxg_integration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable Wxg Integration", "description": "Enable/disable WXG integration for this agent", "default": false } }, "type": "object", "required": [ "name", "description" ], "title": "PatchEnvironment" }, "PatchExternalChatAgent": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Url" }, "auth_scheme": { "anyOf": [ { "$ref": "#/components/schemas/ExternalAgentAuthScheme" }, { "type": "null" } ] }, "auth_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Auth Config" }, "chat_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Chat Params" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/ExternalChatAgentConfig" }, { "type": "null" } ] }, "context_access_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Context Access Enabled", "description": "Enable access to context variables for this agent" }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access" } }, "type": "object", "title": "PatchExternalChatAgent" }, "PatchMCPToolKitConfig": { "properties": { "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "string", "const": "*" }, { "type": "null" } ], "title": "Tools" }, "env": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Env" } }, "type": "object", "title": "PatchMCPToolKitConfig" }, "PatchMessage": { "properties": { "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AssistantContent" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Content" }, "mentions": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/Mention" }, { "$ref": "#/components/schemas/AssistantMention" } ] }, "type": "array" }, { "type": "null" } ], "title": "Mentions" }, "document_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array" }, { "type": "null" } ], "title": "Document Ids" }, "parent_message_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Parent Message Id" }, "additional_properties": { "anyOf": [ { "$ref": "#/components/schemas/AdditionalProperties" }, { "type": "null" } ] }, "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "message_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Message State" }, "context": { "anyOf": [ { "$ref": "#/components/schemas/Context" }, { "type": "null" } ] } }, "type": "object", "title": "PatchMessage" }, "PatchModelConfig": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "policy": { "anyOf": [ { "$ref": "#/components/schemas/FullModelConfig-Input" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "title": "PatchModelConfig" }, "PatchThread": { "properties": { "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "knowledge_base_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Knowledge Base Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ThreadStatus" }, { "type": "null" } ], "default": "ready" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "title": "PatchThread" }, "PatchToolKit": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "mcp": { "anyOf": [ { "$ref": "#/components/schemas/PatchMCPToolKitConfig" }, { "type": "null" } ] } }, "type": "object", "title": "PatchToolKit" }, "PatchUserProfile": { "properties": { "settings": { "$ref": "#/components/schemas/UserProfileSettings" } }, "type": "object", "required": [ "settings" ], "title": "PatchUserProfile" }, "PatchWatsonAssistant": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/WatsonAssistantConfigRequest" }, { "type": "null" } ] }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden" }, "context_access_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Context Access Enabled", "description": "Enable access to context variables for this agent" }, "context_variables": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Context Variables", "description": "List of context variable names that this agent can access" } }, "type": "object", "title": "PatchWatsonAssistant" }, "PayloadIn": { "properties": { "user_payload": { "type": "string", "title": "User Payload" }, "tenant_id": { "type": "string", "title": "Tenant Id" } }, "type": "object", "required": [ "user_payload", "tenant_id" ], "title": "PayloadIn" }, "PayloadOut": { "properties": { "user_payload": { "additionalProperties": true, "type": "object", "title": "User Payload" } }, "type": "object", "required": [ "user_payload" ], "title": "PayloadOut" }, "PhoneErrorCallFailureHandling": { "properties": { "reply_message": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reply Message" } }, "type": "object", "title": "PhoneErrorCallFailureHandling" }, "PhoneErrorHandling": { "properties": { "fallback_sip_uri": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Fallback Sip Uri" }, "transfer_failure": { "anyOf": [ { "$ref": "#/components/schemas/PhoneErrorTransferFailureHandling" }, { "type": "null" } ], "default": {} }, "call_failure": { "anyOf": [ { "$ref": "#/components/schemas/PhoneErrorCallFailureHandling" }, { "type": "null" } ], "default": {} } }, "type": "object", "title": "PhoneErrorHandling" }, "PhoneErrorTransferFailureHandling": { "properties": { "reply_message": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Reply Message" }, "disconnect_call": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disconnect Call", "default": false } }, "type": "object", "title": "PhoneErrorTransferFailureHandling" }, "PhoneSecurity": { "properties": { "api_key": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Api Key" }, "client_secret": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Client Secret" }, "secure_trunking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Secure Trunking", "default": false }, "authentication": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Authentication", "default": false }, "username": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Username" }, "password": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ], "title": "Password" }, "password_is_set": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Password Is Set", "default": false } }, "type": "object", "title": "PhoneSecurity" }, "PolicyCreate": { "properties": { "tenant_rules": { "$ref": "#/components/schemas/ServicePolicy" } }, "type": "object", "required": [ "tenant_rules" ], "title": "PolicyCreate" }, "Prediction": { "properties": { "type": { "type": "string", "title": "Type" }, "content": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PredictionContent" }, "type": "array" }, { "type": "string" } ], "title": "Content" } }, "type": "object", "required": [ "type", "content" ], "title": "Prediction" }, "PredictionContent": { "properties": { "type": { "type": "string", "title": "Type" }, "text": { "type": "string", "title": "Text" } }, "type": "object", "required": [ "type", "text" ], "title": "PredictionContent" }, "ProcessingMode": { "type": "string", "enum": [ "transcript_only", "nba", "both" ], "title": "ProcessingMode", "description": "Enum for types of processing mode." }, "PromptOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "orchestrate_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orchestrate Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "subtitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subtitle" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "State" } }, "type": "object", "title": "PromptOut" }, "PromptTemplates": { "properties": { "chat_template": { "type": "string", "title": "Chat Template", "description": "Prompt template for chat using Jinja2 template language." }, "chat_template_params": { "additionalProperties": true, "type": "object", "title": "Chat Template Params", "description": "Default values for chat template params." } }, "type": "object", "required": [ "chat_template", "chat_template_params" ], "title": "PromptTemplates" }, "PromptsList": { "properties": { "prompts": { "items": { "$ref": "#/components/schemas/CreatePrompt" }, "type": "array", "title": "Prompts" } }, "type": "object", "required": [ "prompts" ], "title": "PromptsList" }, "PythonToolBinding": { "properties": { "function": { "type": "string", "title": "Function", "description": "The fully qualified name of the Python function to call." }, "requirements": { "items": { "type": "string" }, "type": "array", "title": "Requirements", "description": "details of any requirements that are to be installed along with tool" }, "connections": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Connections", "description": "details of the credential connections of the Python tool" } }, "type": "object", "required": [ "function" ], "title": "PythonToolBinding", "description": "A binding for a tool that uses a Python function." }, "QueryRewriteConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Id" } }, "type": "object", "title": "QueryRewriteConfig", "description": "example\n\n{\n \"enabled\": True,\n \"model_id\": \"meta-llama/llama-3-1-70b-instruct\"\n}" }, "QuerySource": { "type": "string", "enum": [ "SessionHistory", "Agent" ], "title": "QuerySource" }, "RegisterUser": { "properties": { "username": { "type": "string", "title": "Username" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TenantPermission" }, "type": "array" }, { "type": "null" } ], "title": "Permissions" } }, "type": "object", "required": [ "username" ], "title": "RegisterUser" }, "RegisterWatsonAssistant": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "type": "string", "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "config": { "$ref": "#/components/schemas/WatsonAssistantConfigRequest" } }, "type": "object", "required": [ "description", "config" ], "title": "RegisterWatsonAssistant" }, "ReleaseAgentIN": { "properties": { "environment_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id", "description": "ID of environment where agent is being released" }, "comments": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comments", "description": "Comments added by the user while releasing an agent" } }, "type": "object", "title": "ReleaseAgentIN", "description": "Input Schema for releasing a draft agent." }, "ResetProperty": { "type": "string", "enum": [ "model", "prompt", "model_param" ], "title": "ResetProperty" }, "Resources": { "properties": { "id": { "type": "string", "title": "Id" }, "label": { "type": "string", "title": "Label" }, "lifecycle": { "items": { "$ref": "#/components/schemas/Lifecycle" }, "type": "array", "title": "Lifecycle" }, "type": { "type": "string", "title": "Type" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "id", "label", "lifecycle", "type", "tags" ], "title": "Resources" }, "ResponseConfidenceThreshold": { "type": "string", "enum": [ "Off", "Lowest", "Low", "High", "Highest" ], "title": "ResponseConfidenceThreshold" }, "ResponseFormat": { "properties": { "type": { "type": "string", "title": "Type" }, "json_schema": { "anyOf": [ {}, { "type": "null" } ], "title": "Json Schema" } }, "type": "object", "required": [ "type" ], "title": "ResponseFormat" }, "RetrievalConfidenceThreshold": { "type": "string", "enum": [ "Off", "Lowest", "Low", "High", "Highest" ], "title": "RetrievalConfidenceThreshold" }, "RetrieveRequest": { "properties": { "query": { "type": "string", "title": "Query" }, "similarity_top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Similarity Top K" }, "max_content_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Content Length" } }, "type": "object", "required": [ "query" ], "title": "RetrieveRequest" }, "RetryConfig": { "properties": { "attempts": { "type": "integer", "title": "Attempts" }, "on_status_codes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "On Status Codes" } }, "type": "object", "required": [ "attempts" ], "title": "RetryConfig" }, "RouterConfig": { "properties": { "continue_journey_on_none": { "type": "boolean", "title": "Continue Journey On None", "default": true }, "confidence_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence Threshold" }, "confidence_method": { "type": "string", "title": "Confidence Method", "default": "perplexity" } }, "additionalProperties": false, "type": "object", "title": "RouterConfig" }, "RouterSettings": { "properties": { "router_type": { "type": "string", "title": "Router Type", "default": "unified" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name", "description": "Name of the model to use for routing. Must be a valid model name available on watsonx.ai." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id", "description": "The ID of a custom configured model to use for routing." }, "model_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model Params", "description": "Default models params to use." }, "routing_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Routing Prompt", "description": "Override the routing prompt used by the Orchestrate routing LLM." }, "router_config": { "anyOf": [ { "$ref": "#/components/schemas/RouterConfig" }, { "type": "null" } ], "description": "Additonal router specific configuration properties." } }, "additionalProperties": false, "type": "object", "title": "RouterSettings" }, "RulesResponse": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "entity_value": { "type": "string", "title": "Entity Value" }, "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "policy", "entity_value", "id" ], "title": "RulesResponse" }, "RulesUpdateRequst": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "entity_value": { "type": "string", "title": "Entity Value" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "comment": { "type": "string", "title": "Comment" } }, "type": "object", "required": [ "policy", "entity_value", "id", "comment" ], "title": "RulesUpdateRequst" }, "RunEvent": { "properties": { "id": { "type": "string", "title": "Id" }, "event": { "$ref": "#/components/schemas/EventType" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" } }, "type": "object", "required": [ "id", "event", "data" ], "title": "RunEvent" }, "RunOrchestrate": { "properties": { "message": { "anyOf": [ { "$ref": "#/components/schemas/CreateMessage" }, { "type": "null" } ] }, "thread_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Thread Id" }, "llm_params": { "anyOf": [ { "$ref": "#/components/schemas/TextGenerationParameters" }, { "type": "null" } ] }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/Guardrails-Input" }, { "type": "null" } ] }, "context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context" }, "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "additional_parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Additional Parameters" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Version" }, "context_variables": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Context Variables", "description": "Context variables for the agent execution (e.g., {'wxo_email_id': 'user@domain.com', 'wxo_user_name': 'John Doe'})" } }, "type": "object", "title": "RunOrchestrate" }, "SearchCorrelationObject": { "properties": { "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "flowinstance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Flowinstance Id" }, "agent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agent Id" }, "user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Id" } }, "type": "object", "title": "SearchCorrelationObject" }, "SearchMode": { "type": "string", "enum": [ "vector", "hybrid", "lexical" ], "title": "SearchMode" }, "SegmentEntity": { "properties": { "type": { "type": "string", "title": "Type" }, "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "type", "value" ], "title": "SegmentEntity" }, "SegmentIntent": { "properties": { "name": { "type": "string", "title": "Name" }, "confidence": { "type": "number", "title": "Confidence" } }, "type": "object", "required": [ "name", "confidence" ], "title": "SegmentIntent" }, "SegmentNLP": { "properties": { "intents": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SegmentIntent" }, "type": "array" }, { "type": "null" } ], "title": "Intents" }, "entities": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SegmentEntity" }, "type": "array" }, { "type": "null" } ], "title": "Entities" } }, "type": "object", "required": [ "intents", "entities" ], "title": "SegmentNLP" }, "SegmentType": { "type": "string", "enum": [ "start", "fragment", "end" ], "title": "SegmentType", "description": "Enum for types of segment" }, "ServiceInstanceMetadata": { "properties": { "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "default": {} }, "serviceInstanceDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancedescription", "default": "" }, "serviceInstanceDisplayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancedisplayname" }, "serviceInstanceNamespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancenamespace" }, "zenServiceInstanceInfo": { "anyOf": [ { "$ref": "#/components/schemas/ZenServiceInstanceInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "serviceInstanceDisplayName", "serviceInstanceNamespace", "zenServiceInstanceInfo" ], "title": "ServiceInstanceMetadata" }, "ServicePolicy": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "rules": { "items": { "$ref": "#/components/schemas/CreateRule" }, "type": "array", "title": "Rules" } }, "type": "object", "required": [ "policy", "rules" ], "title": "ServicePolicy" }, "ServicePolicyResponse": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "rules": { "items": { "$ref": "#/components/schemas/RulesResponse" }, "type": "array", "title": "Rules" } }, "type": "object", "required": [ "policy", "rules" ], "title": "ServicePolicyResponse" }, "ServiceProvider": { "type": "string", "enum": [ "sip_trunk", "genesys_audio_connector" ], "title": "ServiceProvider" }, "Settings-Input": { "properties": { "model_settings": { "anyOf": [ { "$ref": "#/components/schemas/ModelSettings-Input" }, { "type": "null" } ], "description": "Model settings used to define the base LLM and other base models used by Orchestrate." }, "router_settings": { "anyOf": [ { "$ref": "#/components/schemas/RouterSettings" }, { "type": "null" } ], "description": "Configuration of the Router used by Orchestrate." }, "user_settings": { "anyOf": [ { "$ref": "#/components/schemas/UserSettings" }, { "type": "null" } ], "description": "Default user settings." }, "slot_filling_settings": { "anyOf": [ { "$ref": "#/components/schemas/SlotFillerSettings" }, { "type": "null" } ], "description": "Configuration of the Slot filler used by Orchestrate." } }, "additionalProperties": false, "type": "object", "title": "Settings" }, "Settings-Output": { "properties": { "model_settings": { "anyOf": [ { "$ref": "#/components/schemas/ModelSettings-Output" }, { "type": "null" } ], "description": "Model settings used to define the base LLM and other base models used by Orchestrate." }, "router_settings": { "anyOf": [ { "$ref": "#/components/schemas/RouterSettings" }, { "type": "null" } ], "description": "Configuration of the Router used by Orchestrate." }, "user_settings": { "anyOf": [ { "$ref": "#/components/schemas/UserSettings" }, { "type": "null" } ], "description": "Default user settings." }, "slot_filling_settings": { "anyOf": [ { "$ref": "#/components/schemas/SlotFillerSettings" }, { "type": "null" } ], "description": "Configuration of the Slot filler used by Orchestrate." } }, "additionalProperties": false, "type": "object", "title": "Settings" }, "SettingsPatch": { "properties": { "settings": { "$ref": "#/components/schemas/Settings-Input" } }, "type": "object", "required": [ "settings" ], "title": "SettingsPatch" }, "SetupAgentMonitoringRequest": { "properties": { "enable": { "type": "boolean", "title": "Enable", "description": "Flag to enable/disable agent monitoring" } }, "type": "object", "required": [ "enable" ], "title": "SetupAgentMonitoringRequest" }, "SileroVADConfig": { "properties": { "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence", "description": "The confidence threshold for speech detection (between 0.0 and 1.0), default is 0.7", "default": 0.7 }, "start_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Start Seconds", "description": "The time in seconds speech must be detected before transitioning to SPEAKING state, default is 0.2", "default": 0.2 }, "stop_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stop Seconds", "description": "The time in seconds silence must be detected before transitioning to QUIET state, default is 0.8", "default": 0.8 }, "min_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min Volume", "description": "The minimum audio volume threshold for speech detection (between 0.0 and 1.0), default is 0.6", "default": 0.6 } }, "type": "object", "title": "SileroVADConfig" }, "SkillResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Primary key of the artifact" }, "skill_id": { "type": "string", "minLength": 1, "title": "Skill Id", "description": "Skill Id" }, "artifact_name": { "type": "string", "title": "Artifact Name", "description": "Name of the artifact" }, "artifact_type": { "type": "string", "title": "Artifact Type", "description": "Type of the artifact", "default": "SKILL" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the artifact" }, "routing_description": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Routing Description", "description": "Routing description for the artifact" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon", "description": "Icon associated with the artifact" }, "group_id": { "type": "string", "format": "uuid", "title": "Group Id", "description": "Foreign key referencing the artifact_group table" }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name", "description": "Group Name" }, "tenant_id": { "type": "string", "title": "Tenant Id", "description": "Foreign key referencing the tenants table" } }, "type": "object", "required": [ "id", "skill_id", "artifact_name", "routing_description", "group_id", "tenant_id" ], "title": "SkillResponse" }, "SkillToolBinding": { "properties": { "skillset_id": { "type": "string", "title": "Skillset Id", "description": "The ID of the skillset containing the skill to call." }, "skill_id": { "type": "string", "title": "Skill Id", "description": "The ID of the skill to call." }, "skill_operation_path": { "type": "string", "title": "Skill Operation Path", "description": "The path to the skill operation to call." }, "http_method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "title": "Http Method" } }, "type": "object", "required": [ "skillset_id", "skill_id", "skill_operation_path", "http_method" ], "title": "SkillToolBinding", "description": "A binding for a tool that uses a watsonx Orchestrate Skill." }, "SlackAppInstanceCallBack": { "properties": { "access_code": { "type": "string", "title": "Access Code" }, "agent_id": { "type": "string", "title": "Agent Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "app_id": { "type": "string", "title": "App Id" }, "redirect_uri": { "type": "string", "title": "Redirect Uri" } }, "type": "object", "required": [ "access_code", "agent_id", "environment_id", "app_id", "redirect_uri" ], "title": "SlackAppInstanceCallBack" }, "SlackTeam": { "properties": { "id": { "type": "string", "title": "Id" }, "bot_access_token": { "type": "string", "title": "Bot Access Token" } }, "type": "object", "required": [ "id", "bot_access_token" ], "title": "SlackTeam" }, "SlotFillerSettings": { "properties": { "slot_filler_type": { "type": "string", "title": "Slot Filler Type", "default": "unified" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name", "description": "Name of the model to use for slot filling. Must be a valid model name available on watsonx.ai." }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Model Id", "description": "The ID of a custom configured model to use for slot filling." }, "model_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Model Params", "description": "Default models params to use." } }, "additionalProperties": false, "type": "object", "title": "SlotFillerSettings" }, "SortKey": { "type": "string", "enum": [ "created_date", "executed_date", "prompt" ], "title": "SortKey" }, "SortType": { "type": "string", "enum": [ "ASC", "DESC" ], "title": "SortType" }, "SourceType": { "type": "string", "enum": [ "internal", "external" ], "title": "SourceType", "description": "Enum for types of source." }, "SpeechToTextConfig": { "properties": { "provider": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Provider" }, "watson_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/WatsonSTTConfig" }, { "type": "null" } ] }, "emotech_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/EmotechSTTConfig" }, { "type": "null" } ] }, "deepgram_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/DeepgramSTTConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider" ], "title": "SpeechToTextConfig" }, "StatusEnum": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "COMPLETED", "CANCELLED", "FAILED" ], "title": "StatusEnum" }, "StrategyConfig": { "properties": { "mode": { "type": "string", "enum": [ "loadbalance", "fallback", "single" ], "title": "Mode" }, "on_status_codes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "On Status Codes" } }, "type": "object", "required": [ "mode" ], "title": "StrategyConfig" }, "SummaryEvent": { "type": "string", "enum": [ "call-transfer", "on-demand", "call-end" ], "title": "SummaryEvent" }, "SummaryOptions": { "properties": { "event": { "anyOf": [ { "$ref": "#/components/schemas/SummaryEvent" }, { "type": "null" } ], "default": "on-demand" }, "style": { "anyOf": [ { "$ref": "#/components/schemas/SummaryStyle" }, { "type": "null" } ], "default": "brief" }, "periods": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Periods", "default": [] }, "include_tags": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Tags", "default": false }, "push_to_dashboard": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Push To Dashboard", "default": false }, "llm_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Llm Id" }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt" }, "processing_mode": { "anyOf": [ { "$ref": "#/components/schemas/SummaryProcessingMode" }, { "type": "null" } ] } }, "type": "object", "title": "SummaryOptions" }, "SummaryProcessingMode": { "type": "string", "enum": [ "nba" ], "title": "SummaryProcessingMode" }, "SummaryStyle": { "type": "string", "enum": [ "brief", "detailed" ], "title": "SummaryStyle" }, "SupportedApp": { "type": "string", "enum": [ "slack/askhr" ], "title": "SupportedApp" }, "TargetConfig": { "properties": { "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Weight" } }, "additionalProperties": true, "type": "object", "required": [ "model_name" ], "title": "TargetConfig" }, "TaskStatus": { "type": "string", "enum": [ "unknown", "started", "completed", "failed" ], "title": "TaskStatus" }, "TenantOut": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/Settings-Output" }, { "type": "null" } ] } }, "type": "object", "title": "TenantOut" }, "TenantPatch": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/Settings-Input" }, { "type": "null" } ] }, "wxg_service_instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Wxg Service Instance Id" } }, "type": "object", "title": "TenantPatch" }, "TenantPermission": { "type": "integer", "enum": [ 1, 2, 3 ], "title": "TenantPermission" }, "TenantProvisionPayload": { "properties": { "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata", "default": {} }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Parameters", "default": {} }, "serviceInstanceDescription": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancedescription", "default": "" }, "serviceInstanceDisplayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancedisplayname" }, "serviceInstanceNamespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Serviceinstancenamespace" }, "zenServiceInstanceInfo": { "anyOf": [ { "$ref": "#/components/schemas/ZenServiceInstanceInfo" }, { "type": "null" } ] } }, "type": "object", "required": [ "serviceInstanceDisplayName", "serviceInstanceNamespace", "zenServiceInstanceInfo" ], "title": "TenantProvisionPayload" }, "TenantUser": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "title": "TenantUser" }, "TenantUsersFilter": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "title": "TenantUsersFilter" }, "TestCaseResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Test case ID" }, "prompt": { "type": "string", "title": "Prompt", "description": "Prompt text" }, "created_date": { "type": "string", "format": "date-time", "title": "Created Date", "description": "Created date" }, "executed_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Executed Date", "description": "Last executed date" } }, "type": "object", "required": [ "id", "prompt", "created_date" ], "title": "TestCaseResponse" }, "TestCaseStatusEnum": { "type": "string", "enum": [ "IN_PROGRESS", "PASSED", "FAILED" ], "title": "TestCaseStatusEnum" }, "TestCasesListResponse": { "properties": { "total": { "type": "integer", "title": "Total", "description": "Total number of test cases" }, "page": { "type": "integer", "title": "Page", "description": "Current page" }, "page_size": { "type": "integer", "title": "Page Size", "description": "Number of results per page" }, "test_cases": { "items": { "$ref": "#/components/schemas/TestCaseResponse" }, "type": "array", "title": "Test Cases", "description": "List of test cases in this page" } }, "type": "object", "required": [ "total", "page", "page_size", "test_cases" ], "title": "TestCasesListResponse" }, "TextGenerationParameters": { "properties": { "beam_width": { "anyOf": [ { "type": "integer", "maximum": 3.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Beam width" }, "decoding_method": { "anyOf": [ { "$ref": "#/components/schemas/DecodingMethod" }, { "type": "null" } ] }, "include_stop_sequence": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Stop Sequence" }, "length_penalty": { "anyOf": [ { "$ref": "#/components/schemas/LengthPenalty" }, { "type": "null" } ] }, "max_new_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Max new tokens" }, "min_new_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Min new tokens" }, "random_seed": { "anyOf": [ { "type": "integer", "maximum": 4294967295.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Random seed" }, "repetition_penalty": { "anyOf": [ { "type": "number", "multipleOf": 0.01, "maximum": 2.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Repetition penalty" }, "return_options": { "anyOf": [ { "$ref": "#/components/schemas/TextGenerationReturnOptions" }, { "type": "null" } ] }, "stop_sequences": { "anyOf": [ { "items": { "type": "string" }, "type": "array", "maxItems": 6, "minItems": 1 }, { "type": "null" } ], "title": "Stop sequences", "examples": [ "[\" and \"]" ] }, "temperature": { "anyOf": [ { "type": "number", "multipleOf": 0.01, "maximum": 2.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Temperature" }, "time_limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Time limit" }, "top_k": { "anyOf": [ { "type": "integer", "maximum": 100.0, "minimum": 1.0 }, { "type": "null" } ], "title": "Top K" }, "top_p": { "anyOf": [ { "type": "number", "multipleOf": 0.01, "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Top P (nucleus sampling)" }, "truncate_input_tokens": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Truncate input tokens" }, "typical_p": { "anyOf": [ { "type": "number", "multipleOf": 0.01, "maximum": 1.0, "minimum": 0.01 }, { "type": "null" } ], "title": "Typical P" } }, "additionalProperties": true, "type": "object", "title": "TextGenerationParameters" }, "TextGenerationReturnOptions": { "properties": { "generated_tokens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Generated Tokens", "default": false }, "input_parameters": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Input Parameters" }, "input_text": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Input text", "default": false }, "input_tokens": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Input Tokens", "default": false }, "token_logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Token logprobs", "default": false }, "token_ranks": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Token ranks", "default": false }, "top_n_tokens": { "anyOf": [ { "type": "integer", "maximum": 5.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Top N tokens" } }, "additionalProperties": true, "type": "object", "title": "TextGenerationReturnOptions" }, "TextToSpeechConfig": { "properties": { "provider": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Provider" }, "watson_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/WatsonTTSConfig" }, { "type": "null" } ] }, "emotech_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/EmotechTTSConfig" }, { "type": "null" } ] }, "elevenlabs_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/ElevenLabsTTSConfig" }, { "type": "null" } ] }, "deepgram_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/DeepgramTTSConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider" ], "title": "TextToSpeechConfig" }, "Thinking": { "properties": { "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "budget_tokens": { "type": "integer", "title": "Budget Tokens" } }, "type": "object", "required": [ "budget_tokens" ], "title": "Thinking" }, "Thread": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "tenant_id": { "type": "string", "title": "Tenant Id" }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ThreadStatus" }, { "type": "null" } ], "default": "ready" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "assistant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Assistant Id" }, "agent_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Agent Id" }, "knowledge_base_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Knowledge Base Id" }, "created_by": { "type": "string", "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Deleted At" }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By" }, "last_read_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Read At" }, "last_agent_message_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Agent Message At" } }, "type": "object", "required": [ "id", "tenant_id", "created_by", "deleted_at" ], "title": "Thread" }, "ThreadResponseWithPagination": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Thread" }, "type": "array", "title": "Data" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" } }, "type": "object", "required": [ "data", "total", "limit", "offset" ], "title": "ThreadResponseWithPagination" }, "ThreadStatus": { "type": "string", "enum": [ "async_wait", "ready", "async_slot_request", "async_a2a_slot_request" ], "title": "ThreadStatus" }, "Token": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "token_type": { "type": "string", "title": "Token Type" } }, "type": "object", "required": [ "access_token", "token_type" ], "title": "Token" }, "Tool": { "properties": { "type": { "$ref": "#/components/schemas/ToolType", "default": "function" }, "function": { "$ref": "#/components/schemas/Function" } }, "type": "object", "required": [ "function" ], "title": "Tool" }, "ToolBinding-Input": { "properties": { "openapi": { "anyOf": [ { "$ref": "#/components/schemas/OpenApiToolBinding-Input" }, { "type": "null" } ] }, "python": { "anyOf": [ { "$ref": "#/components/schemas/PythonToolBinding" }, { "type": "null" } ] }, "wxflows": { "anyOf": [ { "$ref": "#/components/schemas/WxFlowsToolBinding" }, { "type": "null" } ] }, "skill": { "anyOf": [ { "$ref": "#/components/schemas/SkillToolBinding" }, { "type": "null" } ] }, "client_side": { "anyOf": [ { "$ref": "#/components/schemas/ClientSideToolBinding" }, { "type": "null" } ] }, "conversational_search": { "anyOf": [ { "$ref": "#/components/schemas/ConversationalSearchToolBinding" }, { "type": "null" } ] }, "mcp": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolBinding" }, { "type": "null" } ] }, "flow": { "anyOf": [ { "$ref": "#/components/schemas/FlowToolBinding-Input" }, { "type": "null" } ] }, "langflow": { "anyOf": [ { "$ref": "#/components/schemas/LangflowToolBinding" }, { "type": "null" } ] } }, "type": "object", "title": "ToolBinding", "description": "A binding of the tool to a specific runtime environment such as an OpenAPI endpoint or local Python function." }, "ToolBinding-Output": { "properties": { "openapi": { "anyOf": [ { "$ref": "#/components/schemas/OpenApiToolBinding-Output" }, { "type": "null" } ] }, "python": { "anyOf": [ { "$ref": "#/components/schemas/PythonToolBinding" }, { "type": "null" } ] }, "wxflows": { "anyOf": [ { "$ref": "#/components/schemas/WxFlowsToolBinding" }, { "type": "null" } ] }, "skill": { "anyOf": [ { "$ref": "#/components/schemas/SkillToolBinding" }, { "type": "null" } ] }, "client_side": { "anyOf": [ { "$ref": "#/components/schemas/ClientSideToolBinding" }, { "type": "null" } ] }, "conversational_search": { "anyOf": [ { "$ref": "#/components/schemas/ConversationalSearchToolBinding" }, { "type": "null" } ] }, "mcp": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolBinding" }, { "type": "null" } ] }, "flow": { "anyOf": [ { "$ref": "#/components/schemas/FlowToolBinding-Output" }, { "type": "null" } ] }, "langflow": { "anyOf": [ { "$ref": "#/components/schemas/LangflowToolBinding" }, { "type": "null" } ] } }, "type": "object", "title": "ToolBinding", "description": "A binding of the tool to a specific runtime environment such as an OpenAPI endpoint or local Python function." }, "ToolKitOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "description": { "type": "string", "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "name": { "type": "string", "title": "Name" }, "permission": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission" }, "input_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Schema" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" }, "binding": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Binding" }, "mcp": { "$ref": "#/components/schemas/MCPToolKitConfig" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Uid" }, "collab_idf": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Collab Idf" }, "tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tools" } }, "type": "object", "required": [ "description", "name", "mcp" ], "title": "ToolKitOut" }, "ToolOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "type": "string", "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "permission": { "$ref": "#/components/schemas/ToolPermission" }, "input_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolRequestBody-Output" }, { "type": "null" } ] }, "output_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolResponseBody-Output" }, { "type": "null" } ] }, "binding": { "anyOf": [ { "$ref": "#/components/schemas/ToolBinding-Output" }, { "type": "null" } ] }, "display_name": { "type": "string", "title": "Display Name" }, "uid": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Uid" }, "collab_idf": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Collab Idf" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Environment Id" }, "toolkit_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Toolkit Id" }, "is_async": { "type": "boolean", "title": "Is Async", "description": "Whether the tool execution is asynchronous", "default": false }, "restrictions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Restrictions", "description": "Whether the tool is editable or not", "default": "editable" }, "bundled_agent_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Bundled Agent Id" } }, "type": "object", "required": [ "description", "name", "permission", "display_name" ], "title": "ToolOut" }, "ToolPermission": { "type": "string", "enum": [ "read_only", "write_only", "read_write", "admin" ], "title": "ToolPermission", "description": "The permission level required to use this tool." }, "ToolQualityMetrics": { "properties": { "average": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "accuracy": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "relevance": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] } }, "type": "object", "title": "ToolQualityMetrics" }, "ToolRequestBody-Input": { "properties": { "type": { "type": "string", "enum": [ "object", "string" ], "title": "Type", "default": "object" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/FlexibleProperty-Input" }, "type": "object", "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required", "default": [] } }, "type": "object", "title": "ToolRequestBody", "description": "A request body for a tool." }, "ToolRequestBody-Output": { "properties": { "type": { "type": "string", "enum": [ "object", "string" ], "title": "Type", "default": "object" }, "properties": { "additionalProperties": { "$ref": "#/components/schemas/FlexibleProperty-Output" }, "type": "object", "title": "Properties" }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required", "default": [] } }, "type": "object", "title": "ToolRequestBody", "description": "A request body for a tool." }, "ToolResponseBody-Input": { "properties": { "type": { "type": "string", "enum": [ "object", "string", "number", "integer", "boolean", "array", "null" ], "title": "Type", "default": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/FlexibleProperty-Input" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "items": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, { "type": "null" } ] }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required", "default": [] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "anyOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Anyof" }, "oneOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Oneof" }, "allOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Input" }, "type": "array" }, { "type": "null" } ], "title": "Allof" } }, "type": "object", "title": "ToolResponseBody", "description": "A response body for a tool." }, "ToolResponseBody-Output": { "properties": { "type": { "type": "string", "enum": [ "object", "string", "number", "integer", "boolean", "array", "null" ], "title": "Type", "default": "object" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/FlexibleProperty-Output" }, "type": "object" }, { "type": "null" } ], "title": "Properties" }, "items": { "anyOf": [ { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, { "type": "null" } ] }, "required": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required", "default": [] }, "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Format" }, "anyOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Anyof" }, "oneOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Oneof" }, "allOf": { "anyOf": [ { "items": { "$ref": "#/components/schemas/JsonSchemaObject-Output" }, "type": "array" }, { "type": "null" } ], "title": "Allof" } }, "type": "object", "title": "ToolResponseBody", "description": "A response body for a tool." }, "ToolType": { "type": "string", "enum": [ "function" ], "title": "ToolType" }, "ToolsResponseWithPagination": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ToolOut" }, "type": "array", "title": "Data" }, "total": { "type": "integer", "title": "Total" }, "limit": { "type": "integer", "title": "Limit" }, "offset": { "type": "integer", "title": "Offset" }, "result_count": { "type": "integer", "title": "Result Count" } }, "type": "object", "required": [ "data", "total", "limit", "offset", "result_count" ], "title": "ToolsResponseWithPagination" }, "TranscriptSegment": { "properties": { "segment_id": { "type": "string", "format": "uuid", "title": "Segment Id" }, "tenant_id": { "type": "string", "title": "Tenant Id" }, "conversation_id": { "type": "string", "title": "Conversation Id" }, "recorded_at": { "type": "string", "format": "date-time", "title": "Recorded At" }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" }, "source": { "$ref": "#/components/schemas/SourceType" }, "segment_type": { "$ref": "#/components/schemas/SegmentType" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "segment_id", "tenant_id", "conversation_id", "recorded_at", "source", "segment_type", "meta", "created_on", "updated_at" ], "title": "TranscriptSegment", "description": "Schema for conversation segment record" }, "TrasactionCompletionMetrics": { "properties": { "average": { "anyOf": [ { "$ref": "#/components/schemas/MetricDetail" }, { "type": "null" } ] }, "failed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Failed" }, "success": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Success" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" } }, "type": "object", "title": "TrasactionCompletionMetrics" }, "URLCheckRequest": { "properties": { "urls": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ], "title": "Urls" }, "service_name": { "type": "string", "title": "Service Name", "default": "tenant_rules" } }, "type": "object", "required": [ "urls" ], "title": "URLCheckRequest" }, "UpdateAgentIdleHandler": { "properties": { "pre_hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Pre Hold Message", "description": "The text to play for the user before playing on-hold audio" }, "hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Hold Message", "description": "The text to play to the user periodically while on hold" }, "typing_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Typing Enabled" }, "typing_duration_seconds": { "anyOf": [ { "type": "integer", "maximum": 30.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Typing Duration Seconds" }, "audio_clip_id": { "anyOf": [ { "$ref": "#/components/schemas/AudioClips" }, { "type": "null" } ] }, "hold_audio_seconds": { "anyOf": [ { "type": "integer", "maximum": 120.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Hold Audio Seconds" } }, "type": "object", "title": "UpdateAgentIdleHandler" }, "UpdateAgentIdleHandlerMessages": { "properties": { "pre_hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Pre Hold Message", "description": "The text to play for the user before playing on-hold audio" }, "hold_message": { "anyOf": [ { "type": "string", "maxLength": 250, "minLength": 0 }, { "type": "null" } ], "title": "Hold Message", "description": "The text to play to the user periodically while on hold" } }, "type": "object", "title": "UpdateAgentIdleHandlerMessages" }, "UpdateDTMFInputConfig": { "properties": { "inter_digit_timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Inter Digit Timeout Ms" }, "termination_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Termination Key" }, "maximum_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Count" }, "ignore_speech": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Ignore Speech" } }, "type": "object", "title": "UpdateDTMFInputConfig" }, "UpdateDeepgramSTTConfig": { "properties": { "api_url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "model": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Model" }, "keyterm": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keyterm", "description": "Key terms to boost recognition of" }, "mip_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mip Opt Out", "description": "Opt out of model improvement program" }, "channels": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Channels", "description": "Number of audio channels" }, "diarize": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Diarize", "description": "Enable speaker diarization" }, "dictation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dictation", "description": "Enable dictation mode" }, "endpointing": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Endpointing", "description": "Endpointing silence duration in seconds, or false to disable" }, "extra": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Extra", "description": "Extra parameters to pass to Deepgram" }, "interim_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Interim Results", "description": "Enable interim results" }, "keywords": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keywords", "description": "Keywords to detect" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "BCP-47 language tag" }, "multichannel": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Multichannel", "description": "Transcribe each audio channel independently" }, "numerals": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Numerals", "description": "Convert numbers from written to numerical form" }, "profanity_filter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profanity Filter", "description": "Filter profanity" }, "punctuate": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Punctuate", "description": "Add punctuation and capitalization" }, "redact": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Redact", "description": "Redact sensitive information" }, "replace": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Replace", "description": "Replace specified terms" }, "search": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Search", "description": "Search for specific terms" }, "smart_format": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smart Format", "description": "Apply smart formatting to the transcript" }, "tag": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tag", "description": "Tag for the request" }, "utterance_end_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Utterance End Ms", "description": "How long Deepgram will wait to send UtteranceEnd message after word has been transcribed" }, "vad_events": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Vad Events", "description": "Enable Deepgram's voice activity detection events" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version", "description": "API version" }, "eager_eot_threshold": { "anyOf": [ { "type": "number", "maximum": 0.9, "minimum": 0.3 }, { "type": "null" } ], "title": "Eager Eot Threshold", "description": "End-of-turn confidence required to fire an eager EOT event, between (0.3 - 0.9)" }, "eot_threshold": { "anyOf": [ { "type": "number", "maximum": 0.9, "minimum": 0.5 }, { "type": "null" } ], "title": "Eot Threshold", "description": "End-of-turn confidence required to finish a turn, between (0.5 - 0.9)" }, "eot_timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Eot Timeout Ms", "description": "A turn will be finished when this much time (ms) has passed after speech, regardless of EOT confidence" } }, "type": "object", "title": "UpdateDeepgramSTTConfig" }, "UpdateDeepgramTTSConfig": { "properties": { "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key", "description": "Deepgram API key." }, "mip_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Mip Opt Out", "description": "Opt out of model improvement program." }, "model": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Model", "description": "The ID (canonical name) of the Deepgram model to use." }, "language": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Language", "description": "An optional UI indicator to help the UI show different languages." } }, "type": "object", "required": [ "api_key" ], "title": "UpdateDeepgramTTSConfig" }, "UpdateElevenLabsPronounciationDict": { "properties": { "pronunciation_dictionary_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pronunciation Dictionary Id", "description": "ID of the pronunciation dictionary" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version Id", "description": "Version ID of the pronunciation dictionary" } }, "type": "object", "title": "UpdateElevenLabsPronounciationDict" }, "UpdateElevenLabsTTSConfig": { "properties": { "model_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Model Id" }, "voice_id": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Voice Id" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "apply_text_normalization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Apply Text Normalization" }, "language_code": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 2 }, { "type": "null" } ], "title": "Language Code" }, "optimize_streaming_latency": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Optimize Streaming Latency" }, "apply_language_text_normalization": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Apply Language Text Normalization" }, "pronunciation_dictionary_locators": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UpdateElevenLabsPronounciationDict" }, "type": "array" }, { "type": "null" } ], "title": "Pronunciation Dictionary Locators" }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "previous_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Text" }, "next_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Text" }, "voice_settings": { "anyOf": [ { "$ref": "#/components/schemas/UpdateElevenLabsVoiceSettings" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateElevenLabsTTSConfig" }, "UpdateElevenLabsVoiceSettings": { "properties": { "speed": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Speed", "description": "Speech speed" }, "style": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Style", "description": "Style factor" }, "stability": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stability", "description": "Stability factor" }, "similarity_boost": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Similarity Boost", "description": "Similarity boost factor" }, "use_speaker_boost": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Use Speaker Boost", "description": "Whether to use speaker boost" } }, "type": "object", "title": "UpdateElevenLabsVoiceSettings" }, "UpdateEmotechSTTConfig": { "properties": { "api_url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "positive_speech_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Positive Speech Threshold", "description": "Confidence threshold above which audio is classified as speech, default is 0.25", "default": 0.25 }, "negative_speech_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Negative Speech Threshold", "description": "Confidence threshold below which audio is classified as non-speech, default is 0.25", "default": 0.25 }, "partial_interval": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partial Interval", "description": "Time interval (in ms) between partial transcription results, default is 500 ms.", "default": 500 }, "silence_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Silence Threshold", "description": "Silence duration (in ms) after speech used to determine end of utterance, default is 1500 ms.", "default": 500 } }, "type": "object", "title": "UpdateEmotechSTTConfig" }, "UpdateEmotechTTSConfig": { "properties": { "api_url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "voice": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Voice" } }, "type": "object", "title": "UpdateEmotechTTSConfig" }, "UpdateFacebookChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "facebook", "title": "Channel", "default": "facebook" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "application_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Secret" }, "verification_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification Token" }, "page_access_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Page Access Token" } }, "type": "object", "title": "UpdateFacebookChannel" }, "UpdateGenesysAudioConnectorChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "genesys_audio_connector", "title": "Channel", "default": "genesys_audio_connector" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" } }, "type": "object", "title": "UpdateGenesysAudioConnectorChannel" }, "UpdateGenesysBotConnectorChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "genesys_bot_connector", "title": "Channel", "default": "genesys_bot_connector" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "verification_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verification Token" }, "api_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Url" }, "bot_connector_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bot Connector Id" } }, "type": "object", "title": "UpdateGenesysBotConnectorChannel" }, "UpdateLanguageVoiceConfig": { "properties": { "text_to_speech": { "anyOf": [ { "$ref": "#/components/schemas/UpdateTextToSpeechConfig" }, { "type": "null" } ] }, "speech_to_text": { "anyOf": [ { "$ref": "#/components/schemas/UpdateSpeechToTextConfig" }, { "type": "null" } ] }, "agent_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/UpdateAgentIdleHandlerMessages" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateLanguageVoiceConfig" }, "UpdatePhoneConfig": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "service_provider": { "anyOf": [ { "$ref": "#/components/schemas/ServiceProvider" }, { "type": "null" } ] }, "security": { "anyOf": [ { "$ref": "#/components/schemas/PhoneSecurity" }, { "type": "null" } ] }, "attached_environments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CreateAttachedAgentConfig" }, "type": "array" }, { "type": "null" } ], "title": "Attached Environments" }, "custom_invite_headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CustomInviteHeader" }, "type": "array" }, { "type": "null" } ], "title": "Custom Invite Headers" }, "put_caller_on_hold_on_transfer": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Put Caller On Hold On Transfer" }, "send_provisional_response": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Send Provisional Response" }, "error_handling": { "anyOf": [ { "$ref": "#/components/schemas/PhoneErrorHandling" }, { "type": "null" } ] }, "phone_numbers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CreatePhoneNumberConfig" }, "type": "array" }, { "type": "null" } ], "title": "Phone Numbers" } }, "type": "object", "title": "UpdatePhoneConfig" }, "UpdatePolicyResponse": { "properties": { "updated": { "type": "boolean", "title": "Updated" }, "failed": { "type": "integer", "title": "Failed" }, "results": { "additionalProperties": { "$ref": "#/components/schemas/UpdatePolicyRulesResponse" }, "type": "object", "title": "Results" } }, "type": "object", "required": [ "updated", "failed", "results" ], "title": "UpdatePolicyResponse" }, "UpdatePolicyRulesResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "title": "Status" } }, "type": "object", "required": [ "id", "status" ], "title": "UpdatePolicyRulesResponse" }, "UpdateSileroVADConfig": { "properties": { "confidence": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Confidence" }, "start_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Start Seconds" }, "stop_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Stop Seconds" }, "min_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min Volume" } }, "type": "object", "title": "UpdateSileroVADConfig" }, "UpdateSlackChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "byo_slack", "title": "Channel", "default": "byo_slack" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "client_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Id" }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "signing_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Signing Secret" }, "teams": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SlackTeam" }, "type": "array" }, { "type": "null" } ], "title": "Teams" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" } }, "type": "object", "title": "UpdateSlackChannel" }, "UpdateSpeechToTextConfig": { "properties": { "provider": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Provider" }, "watson_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateWatsonSTTConfig" }, { "type": "null" } ] }, "emotech_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateEmotechSTTConfig" }, { "type": "null" } ] }, "deepgram_stt_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateDeepgramSTTConfig" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateSpeechToTextConfig" }, "UpdateTeamsChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "teams", "title": "Channel", "default": "teams" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "app_password": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Password" }, "app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Id" }, "teams_tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Teams Tenant Id" } }, "type": "object", "title": "UpdateTeamsChannel" }, "UpdateTextToSpeechConfig": { "properties": { "provider": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Provider" }, "watson_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateWatsonTTSConfig" }, { "type": "null" } ] }, "emotech_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateEmotechTTSConfig" }, { "type": "null" } ] }, "elevenlabs_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateElevenLabsTTSConfig" }, { "type": "null" } ] }, "deepgram_tts_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateDeepgramTTSConfig" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateTextToSpeechConfig" }, "UpdateTwilioSMSChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "twilio_sms", "title": "Channel", "default": "twilio_sms" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "account_sid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Sid" }, "twilio_authentication_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Twilio Authentication Token" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" } }, "type": "object", "title": "UpdateTwilioSMSChannel" }, "UpdateTwilioWhatsappChannel": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "channel_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel App Id" }, "channel": { "type": "string", "const": "twilio_whatsapp", "title": "Channel", "default": "twilio_whatsapp" }, "created_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "description": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ], "title": "Description" }, "account_sid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Sid" }, "twilio_authentication_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Twilio Authentication Token" } }, "type": "object", "title": "UpdateTwilioWhatsappChannel" }, "UpdateVADConfig": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" }, "provider": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Provider" }, "silero_vad_config": { "anyOf": [ { "$ref": "#/components/schemas/UpdateSileroVADConfig" }, { "type": "null" } ] } }, "type": "object", "required": [ "provider" ], "title": "UpdateVADConfig" }, "UpdateVoiceConfiguration": { "properties": { "name": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Name" }, "llm_aggregation_timeout_seconds": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Llm Aggregation Timeout Seconds" }, "speech_to_text": { "anyOf": [ { "$ref": "#/components/schemas/UpdateSpeechToTextConfig" }, { "type": "null" } ] }, "text_to_speech": { "anyOf": [ { "$ref": "#/components/schemas/UpdateTextToSpeechConfig" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 2 }, { "type": "null" } ], "title": "Language", "description": "Default language code, e.g., 'en-us'" }, "additional_languages": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/UpdateLanguageVoiceConfig" }, "type": "object" }, { "type": "null" } ], "title": "Additional Languages", "description": "Additional language configurations keyed by language code" }, "dtmf_input": { "anyOf": [ { "$ref": "#/components/schemas/UpdateDTMFInputConfig" }, { "type": "null" } ] }, "vad": { "anyOf": [ { "$ref": "#/components/schemas/UpdateVADConfig" }, { "type": "null" } ] }, "user_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/UserIdleHandlerConfig" }, { "type": "null" } ] }, "agent_idle_handler": { "anyOf": [ { "$ref": "#/components/schemas/UpdateAgentIdleHandler" }, { "type": "null" } ] } }, "type": "object", "title": "UpdateVoiceConfiguration" }, "UpdateWatsonSTTConfig": { "properties": { "api_url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Url" }, "model": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Model" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "bearer_token": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Bearer Token" }, "background_audio_suppression": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Background Audio Suppression", "description": "Background audio suppression level (0.0 to 1.0). Default 0.0" }, "language_customization_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Language Customization Id", "description": "Language customization ID" }, "inactivity_timeout": { "anyOf": [ { "type": "integer", "minimum": -1.0 }, { "type": "null" } ], "title": "Inactivity Timeout", "description": "Seconds of inactivity before the service stops listening. Default 30" }, "profanity_filter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profanity Filter", "description": "Filter profanity in the transcript. Default true" }, "smart_formatting": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smart Formatting", "description": "Enable smart formatting (beta). Default false" }, "speaker_labels": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Speaker Labels", "description": "Enable speaker labels (beta). Default false" }, "redaction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Redaction", "description": "Enable PII redaction (beta). Default false" }, "low_latency": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Low Latency", "description": "Enable low latency mode. Default false" }, "learning_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Learning Opt Out", "description": "Opt out of data collection for learning. Default true" }, "watson_metadata": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1 }, { "type": "null" } ], "title": "Watson Metadata", "description": "Value for x-watson-metadata header." }, "smart_formatting_version": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Smart Formatting Version", "description": "Version of smart formatting to use." }, "customization_weight": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Customization Weight", "description": "Weight for custom language model (0.0 to 1.0). Default 0.5" }, "character_insertion_bias": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": -1.0 }, { "type": "null" } ], "title": "Character Insertion Bias", "description": "Bias for character insertion (-1.0 to 1.0). Default 0.0" }, "end_of_phrase_silence_time": { "anyOf": [ { "type": "number", "maximum": 120.0, "minimum": 0.0 }, { "type": "null" } ], "title": "End Of Phrase Silence Time", "description": "Seconds of silence that indicate end of a phrase. Default 0.8" } }, "type": "object", "title": "UpdateWatsonSTTConfig" }, "UpdateWatsonTTSConfig": { "properties": { "api_url": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "bearer_token": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Bearer Token" }, "voice": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Voice" }, "rate_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rate Percentage", "description": "Rate percentage for speech synthesis, default is 0", "default": 0 }, "pitch_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pitch Percentage", "description": "Pitch percentage for speech synthesis, default is 0", "default": 0 }, "language": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 2 }, { "type": "null" } ], "title": "Language", "description": "Language code for the voice, e.g., 'en-US'" }, "customization_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Customization Id", "description": "Custom ID for the Watson TTS service" }, "meta_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Meta Id", "description": "Meta ID for the Watson TTS service" }, "learning_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Learning Opt Out", "description": "Set to true to opt out of data collection for learning purposes" } }, "type": "object", "title": "UpdateWatsonTTSConfig" }, "UploadTestCasesResponse": { "properties": { "test_case_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Test Case Ids" }, "total_test_cases": { "type": "integer", "title": "Total Test Cases" } }, "type": "object", "required": [ "test_case_ids", "total_test_cases" ], "title": "UploadTestCasesResponse" }, "UserIdleHandlerConfig": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Enable idle handling. If false, we disconnect on timeout without playing a prompt.", "default": false }, "idle_timeout": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Idle Timeout", "description": "Idle timeout in seconds before triggering the handler (default 7s).", "default": 7 }, "idle_max_reprompts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Idle Max Reprompts", "description": "How many times to replay before ending the session (0 = end immediately).", "default": 2 }, "idle_timeout_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idle Timeout Message", "description": "Message to play on idle; language-specific variants may override this.", "default": "" } }, "type": "object", "title": "UserIdleHandlerConfig" }, "UserIdleHandlerLangConfig": { "properties": { "idle_timeout_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idle Timeout Message", "description": "Localized idle message for this language.", "default": "" } }, "type": "object", "title": "UserIdleHandlerLangConfig" }, "UserInfo": { "properties": { "uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Uid" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "type": "object", "title": "UserInfo" }, "UserPayload": { "properties": { "CurrentUserRecord": { "anyOf": [ { "$ref": "#/components/schemas/UserInfo" }, { "type": "null" } ] }, "ServiceInstanceMetadata": { "anyOf": [ { "$ref": "#/components/schemas/ServiceInstanceMetadata" }, { "type": "null" } ] }, "users": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserInfo" }, "type": "array" }, { "type": "null" } ], "title": "Users" }, "groups": { "items": {}, "type": "array", "title": "Groups" } }, "type": "object", "required": [ "CurrentUserRecord", "ServiceInstanceMetadata", "users" ], "title": "UserPayload" }, "UserProfileOut": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "username": { "type": "string", "title": "Username" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/UserProfileSettings" }, { "type": "null" } ] } }, "type": "object", "required": [ "user_id", "username" ], "title": "UserProfileOut" }, "UserProfileSettings": { "properties": { "confirm_routing": { "type": "boolean", "title": "Confirm Routing", "description": "Should Orchestrate confirm routing decisions explicity with the user. Enabled by default.", "default": true }, "base_llm_model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Llm Model Id", "description": "The base LLM model used by Orchestrate. By default, Orchestrate will use the system configured base LLM." } }, "type": "object", "title": "UserProfileSettings" }, "UserSettings": { "properties": { "confirm_routing": { "type": "boolean", "title": "Confirm Routing", "description": "Should Orchestrate confirm routing decisions explicity with the user. Enabled by default.", "default": true }, "clear_watsonx_assistant_context": { "type": "boolean", "title": "Clear Watsonx Assistant Context", "description": "If set to `True` AND the last turn event was from a Dialog Assistant where `branch_exited` was set to `True` and `branch_completion_reason` is `completed`, then the prior context is cleared", "default": false }, "clientside_shortlisting": { "type": "boolean", "title": "Clientside Shortlisting", "description": "if clientside shortlisting is enabled, we would expect custom_routing_table in the message. Default to False.", "default": false } }, "additionalProperties": false, "type": "object", "title": "UserSettings" }, "VADConfig": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Enable Voice Activity Detection, default is true.", "default": true }, "provider": { "anyOf": [ { "type": "string", "maxLength": 128, "minLength": 1 }, { "type": "null" } ], "title": "Provider", "default": "silero_vad" }, "silero_vad_config": { "anyOf": [ { "$ref": "#/components/schemas/SileroVADConfig" }, { "type": "null" } ] } }, "type": "object", "title": "VADConfig" }, "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" }, "VectorIndex": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "type": "string", "title": "Name" }, "embeddings_model_name": { "type": "string", "title": "Embeddings Model Name" }, "chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Size", "default": 400 }, "chunk_overlap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Overlap", "default": 20 }, "status": { "$ref": "#/components/schemas/VectorIndexStatus", "default": "not_ready" }, "status_msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Msg" }, "top_k": { "type": "integer", "title": "Top K", "default": 10 }, "extraction_strategy": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "standard" } }, "type": "object", "required": [ "name", "embeddings_model_name" ], "title": "VectorIndex" }, "VectorIndexOut": { "properties": { "embeddings_model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Embeddings Model Name" }, "chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Size" }, "chunk_overlap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Overlap" }, "status": { "$ref": "#/components/schemas/VectorIndexStatus", "default": "not_ready" }, "status_msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Msg" }, "top_k": { "type": "integer", "title": "Top K", "default": 10 }, "extraction_strategy": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "standard" } }, "type": "object", "title": "VectorIndexOut" }, "VectorIndexPatch": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "embeddings_model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Embeddings Model Id" }, "chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Size", "default": 500 }, "chunk_overlap": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Chunk Overlap", "default": 20 }, "extraction_strategy": { "$ref": "#/components/schemas/ExtractionStrategy", "default": "standard" } }, "type": "object", "title": "VectorIndexPatch" }, "VectorIndexStatus": { "type": "string", "enum": [ "ready", "not_ready", "rebuilding", "error", "update_pending" ], "title": "VectorIndexStatus" }, "VersionFeatures": { "properties": { "push_notifications": { "type": "boolean", "title": "Push Notifications", "description": "Support for push notifications from agent to server" }, "streaming": { "type": "boolean", "title": "Streaming", "description": "Support for streaming responses" }, "send_history": { "type": "boolean", "title": "Send History", "description": "Support for sending conversation history" } }, "type": "object", "required": [ "push_notifications", "streaming", "send_history" ], "title": "VersionFeatures", "description": "Feature flags supported by a specific A2A version." }, "Voice": { "properties": { "enable_on_homepage": { "type": "boolean", "title": "Enable On Homepage", "description": "Enable voice on homepage", "default": false }, "enable_on_embed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enable On Embed", "description": "Enable voice on homepage", "default": false } }, "type": "object", "title": "Voice" }, "WatsonAssistantAuthType": { "type": "string", "enum": [ "ICP_IAM", "IBM_CLOUD_IAM", "MCSP", "BEARER_TOKEN", "" ], "title": "WatsonAssistantAuthType" }, "WatsonAssistantAuthTypeRequest": { "type": "string", "enum": [ "ICP_IAM", "IBM_CLOUD_IAM", "MCSP", "BEARER_TOKEN" ], "title": "WatsonAssistantAuthTypeRequest" }, "WatsonAssistantConfigRequest": { "properties": { "assistant_id": { "type": "string", "title": "Assistant Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "action_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Title" }, "search_stickiness": { "type": "boolean", "title": "Search Stickiness", "default": false }, "shareable_context": { "type": "boolean", "title": "Shareable Context", "default": true }, "hidden": { "type": "boolean", "title": "Hidden", "default": false }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "service_instance_url": { "type": "string", "title": "Service Instance Url" }, "api_version": { "type": "string", "title": "Api Version", "default": "2023-06-15" }, "auth_type": { "$ref": "#/components/schemas/WatsonAssistantAuthTypeRequest", "default": "BEARER_TOKEN" }, "auth_config": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Auth Config" }, "authorization_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization Url" }, "crn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Crn" }, "message_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Message Context" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] } }, "type": "object", "required": [ "assistant_id", "environment_id", "service_instance_url" ], "title": "WatsonAssistantConfigRequest" }, "WatsonAssistantOut": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Id" }, "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "tenant_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Name" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_by_username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By Username" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "type": { "type": "string", "title": "Type" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "nickname": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nickname" }, "api_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Key" }, "service_instance_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Instance Url" }, "assistant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Assistant Id" }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id" }, "api_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Api Version", "default": "2023-06-15" }, "auth_type": { "anyOf": [ { "$ref": "#/components/schemas/WatsonAssistantAuthType" }, { "type": "null" } ] }, "authorization_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization Url" }, "crn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Crn" }, "intent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Intent" }, "action_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Title" }, "search_stickiness": { "type": "boolean", "title": "Search Stickiness", "default": false }, "shareable_context": { "type": "boolean", "title": "Shareable Context", "default": true }, "hidden": { "type": "boolean", "title": "Hidden", "default": false }, "message_context": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Message Context" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id" }, "context_access_enabled": { "type": "boolean", "title": "Context Access Enabled", "description": "Enable access to context variables for this agent", "default": true }, "context_variables": { "items": { "type": "string" }, "type": "array", "title": "Context Variables", "description": "List of context variable names that this agent can access", "default": [] } }, "type": "object", "required": [ "type" ], "title": "WatsonAssistantOut" }, "WatsonSTTConfig": { "properties": { "api_url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Api Url" }, "model": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Model" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "bearer_token": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Bearer Token" }, "background_audio_suppression": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Background Audio Suppression", "description": "Background audio suppression level (0.0 to 1.0). Default 0.0" }, "language_customization_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Language Customization Id", "description": "Language customization ID" }, "inactivity_timeout": { "anyOf": [ { "type": "integer", "minimum": -1.0 }, { "type": "null" } ], "title": "Inactivity Timeout", "description": "Seconds of inactivity before the service stops listening. Default 30" }, "profanity_filter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Profanity Filter", "description": "Filter profanity in the transcript. Default true" }, "smart_formatting": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Smart Formatting", "description": "Enable smart formatting (beta). Default false" }, "speaker_labels": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Speaker Labels", "description": "Enable speaker labels (beta). Default false" }, "redaction": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Redaction", "description": "Enable PII redaction (beta). Default false" }, "low_latency": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Low Latency", "description": "Enable low latency mode. Default false" }, "learning_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Learning Opt Out", "description": "Opt out of data collection for learning. Default true" }, "watson_metadata": { "anyOf": [ { "type": "string", "maxLength": 512, "minLength": 1 }, { "type": "null" } ], "title": "Watson Metadata", "description": "Value for x-watson-metadata header." }, "smart_formatting_version": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Smart Formatting Version", "description": "Version of smart formatting to use." }, "customization_weight": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Customization Weight", "description": "Weight for custom language model (0.0 to 1.0). Default 0.5" }, "character_insertion_bias": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": -1.0 }, { "type": "null" } ], "title": "Character Insertion Bias", "description": "Bias for character insertion (-1.0 to 1.0). Default 0.0" }, "end_of_phrase_silence_time": { "anyOf": [ { "type": "number", "maximum": 120.0, "minimum": 0.0 }, { "type": "null" } ], "title": "End Of Phrase Silence Time", "description": "Seconds of silence that indicate end of a phrase. Default 0.8" } }, "type": "object", "required": [ "api_url", "model" ], "title": "WatsonSTTConfig" }, "WatsonTTSConfig": { "properties": { "api_url": { "type": "string", "maxLength": 2048, "minLength": 1, "title": "Api Url" }, "api_key": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Api Key" }, "bearer_token": { "anyOf": [ { "type": "string", "maxLength": 2048, "minLength": 1 }, { "type": "null" } ], "title": "Bearer Token" }, "voice": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Voice" }, "rate_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rate Percentage", "description": "Rate percentage for speech synthesis, default is 0", "default": 0 }, "pitch_percentage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pitch Percentage", "description": "Pitch percentage for speech synthesis, default is 0", "default": 0 }, "language": { "anyOf": [ { "type": "string", "maxLength": 16, "minLength": 2 }, { "type": "null" } ], "title": "Language", "description": "Language code for the voice, e.g., 'en-US'" }, "customization_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Customization Id", "description": "Custom ID for the Watson TTS service" }, "meta_id": { "anyOf": [ { "type": "string", "maxLength": 256, "minLength": 1 }, { "type": "null" } ], "title": "Meta Id", "description": "Meta ID for the Watson TTS service" }, "learning_opt_out": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Learning Opt Out", "description": "Set to true to opt out of data collection for learning purposes" } }, "type": "object", "required": [ "api_url", "voice" ], "title": "WatsonTTSConfig" }, "WelcomeContentIn": { "properties": { "welcome_message": { "type": "string", "title": "Welcome Message", "description": "Welcome message" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description" } }, "type": "object", "required": [ "welcome_message" ], "title": "WelcomeContentIn" }, "WelcomeContentOut": { "properties": { "tenant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tenant Id" }, "created_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created On" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By" }, "orchestrate_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Orchestrate Id" }, "welcome_message": { "type": "string", "title": "Welcome Message" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "isDefaultMessage": { "type": "boolean", "title": "Isdefaultmessage", "default": false } }, "type": "object", "required": [ "welcome_message" ], "title": "WelcomeContentOut" }, "WxFlowsToolBinding": { "properties": { "endpoint": { "type": "string", "title": "Endpoint", "description": "The wxflows endpoint." }, "flow_name": { "type": "string", "title": "Flow Name", "description": "The name of the flow to call." }, "security": { "$ref": "#/components/schemas/OpenApiSecurityScheme", "default": [] } }, "type": "object", "required": [ "endpoint", "flow_name" ], "title": "WxFlowsToolBinding", "description": "A binding for a tool that uses a watsonx.ai Flows agent." }, "WxoConnectionStatus": { "properties": { "connection_status": { "type": "string", "title": "Connection Status" }, "connection_message": { "type": "string", "title": "Connection Message" } }, "type": "object", "title": "WxoConnectionStatus" }, "ZenServiceInstanceInfo": { "properties": { "zenCloudPakInstanceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zencloudpakinstanceid" }, "zenControlPlaneNamespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zencontrolplanenamespace" }, "zenImageRegistryPrefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenimageregistryprefix" }, "zenServiceInstanceId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstanceid" }, "zenServiceInstanceSecret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstancesecret" }, "zenServiceInstanceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstancetype" }, "zenServiceInstanceUID": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstanceuid" }, "zenServiceInstanceUserName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstanceusername" }, "zenServiceInstanceVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Zenserviceinstanceversion" } }, "type": "object", "required": [ "zenCloudPakInstanceId", "zenControlPlaneNamespace", "zenImageRegistryPrefix", "zenServiceInstanceId", "zenServiceInstanceSecret", "zenServiceInstanceType", "zenServiceInstanceUID", "zenServiceInstanceUserName", "zenServiceInstanceVersion" ], "title": "ZenServiceInstanceInfo" }, "fastapi___compat__v2__Body_upload_to_s3_v1_orchestrate_upload_to_s3__post": { "properties": { "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "files" ], "title": "Body_upload_to_s3_v1_orchestrate_upload_to_s3__post" }, "wo_archer__observability__models__base__SortOptions": { "type": "string", "enum": [ "asc", "desc" ], "title": "SortOptions" }, "wo_archer__schema__agents__SortOptions": { "type": "string", "enum": [ "asc", "desc", "recent" ], "title": "SortOptions" }, "wo_archer__schema__models__ModelType": { "type": "string", "enum": [ "chat", "chat_vision", "completion", "embedding" ], "title": "ModelType" }, "wo_archer__schema__outbound_policy__UpdatePolicyRequest": { "properties": { "tenant_rules": { "$ref": "#/components/schemas/wo_archer__schema__outbound_policy__UpdatePolicyRequest__1" } }, "type": "object", "required": [ "tenant_rules" ], "title": "UpdatePolicyRequest" }, "wo_archer__schema__outbound_policy__UpdatePolicyRequest__1": { "properties": { "policy": { "$ref": "#/components/schemas/OutboundPolicyEnum" }, "rules": { "items": { "$ref": "#/components/schemas/RulesUpdateRequst" }, "type": "array", "title": "Rules" } }, "type": "object", "required": [ "policy", "rules" ], "title": "UpdatePolicyRequest" }, "wo_archer__schema__tools__SortOptions": { "type": "string", "enum": [ "asc", "desc", "recent" ], "title": "SortOptions" }, "ChatWithDocsConfig": { "properties": { "enabled": { "type": "boolean", "title": "Enabled", "description": "Controls if the Chat with Documents feature is enabled for this agent", "default": false }, "supports_full_document": { "type": "boolean", "title": "Supports Full Document", "description": "Controls if the Agent can request to use the full document. Only used if generation.enabled = false", "default": true }, "vector_index": { "$ref": "#/components/schemas/KnowledgeBaseBuiltInVectorIndexConfig" }, "generation": { "$ref": "#/components/schemas/GenerationConfiguration" }, "query_rewrite": { "$ref": "#/components/schemas/QueryRewriteConfig" }, "confidence_thresholds": { "$ref": "#/components/schemas/ConfidenceThresholds" }, "citations": { "$ref": "#/components/schemas/CitationsConfig" }, "hap_filtering": { "$ref": "#/components/schemas/HAPFiltering" }, "query_source": { "$ref": "#/components/schemas/QuerySource", "default": "Agent" }, "agent_query_description": { "type": "string", "title": "Agent Query Description", "default": "The query to search for in the knowledge base" } }, "type": "object", "title": "ChatWithDocsConfig" }, "ConnectionRequirement": { "properties": { "required_app_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Required App Ids", "description": "App IDs required by the agent (all must be present)" } }, "type": "object", "title": "ConnectionRequirement", "description": "A specification for a custom agent connection requirement." }, "ContextSettings": { "properties": { "context_compaction_enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Context Compaction Enabled", "description": "Enable context compaction" }, "context_compaction_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Context Compaction Threshold", "description": "Token threshold for context compaction" }, "compaction_sliding_window": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Compaction Sliding Window", "description": "Sliding window size for compaction" }, "large_message_threshold": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Large Message Threshold", "description": "Token threshold for large message handling" }, "large_message_chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Large Message Chunk Size", "description": "Chunk size for large message processing" }, "large_message_target_summary": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Large Message Target Summary", "description": "Target summary size for large messages" }, "large_message_detect_structured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Large Message Detect Structured", "description": "Enable structured data detection" } }, "type": "object", "title": "ContextSettings", "description": "Context management settings for an agent." }, "CustomAgentsMetadata": { "properties": { "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language", "description": "Programming language (e.g., 'Python', 'TypeScript')" }, "framework": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Framework", "description": "Framework used (e.g., 'LangGraph')" }, "tool_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tool Count", "description": "Number of tools included in the agent" }, "tool_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Names", "description": "Names of tools included in the agent" }, "connection_requirements": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/ConnectionRequirement" }, "type": "object" }, { "type": "null" } ], "title": "Connection Requirements", "description": "Dictionary of required connections for the agent, mapping tool names to connection requirements and global requirements" } }, "type": "object", "title": "CustomAgentsMetadata", "description": "Metadata for custom agents extracted from uploaded packages." }, "ModelConfig": { "properties": { "decoding_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decoding Method" }, "prompt": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Prompt" }, "max_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tokens" }, "max_completion_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Completion Tokens" }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "n": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "N" }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream" }, "logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Logprobs" }, "top_logprobs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Top Logprobs" }, "echo": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Echo" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Stop" }, "presence_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Presence Penalty" }, "frequency_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Frequency Penalty" }, "best_of": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Best Of" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "context": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Context" }, "examples": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Examples" }, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top K" }, "response_format": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFormat" }, { "type": "null" } ] }, "seed": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Seed" }, "store": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store" }, "metadata": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "modalities": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Modalities" }, "audio": { "anyOf": [ { "$ref": "#/components/schemas/AudioConfig" }, { "type": "null" } ] }, "service_tier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Tier" }, "prediction": { "anyOf": [ { "$ref": "#/components/schemas/Prediction" }, { "type": "null" } ] }, "safety_settings": { "anyOf": [ {}, { "type": "null" } ], "title": "Safety Settings" }, "anthropic_beta": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Beta" }, "anthropic_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Anthropic Version" }, "thinking": { "anyOf": [ { "$ref": "#/components/schemas/Thinking" }, { "type": "null" } ] }, "space_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Space Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "reasoning_effort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reasoning Effort" }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls" }, "disable_parallel_tool_use": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disable Parallel Tool Use" }, "disable_tool_validation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disable Tool Validation" }, "verbosity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Verbosity" }, "thinking_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thinking Level" } }, "additionalProperties": false, "type": "object", "title": "ModelConfig" }, "Plugin": { "properties": { "plugin_id": { "type": "string", "title": "Plugin Id", "description": "Plugins to the invoke before agent" } }, "type": "object", "title": "Plugin" }, "Plugins": { "properties": { "agent_pre_invoke": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Plugin" }, "type": "array" }, { "type": "null" } ], "title": "Agent Pre Invoke", "description": "Plugins to the invoke before agent" }, "agent_post_invoke": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Plugin" }, "type": "array" }, { "type": "null" } ], "title": "Agent Post Invoke", "description": "Plugins to the invoke after agent" } }, "type": "object", "title": "Plugins" }, "RealtimeAgentSettings": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Whether the realtime agent is enabled" } }, "type": "object", "title": "RealtimeAgentSettings", "description": "Base model for realtime agent settings" }, "RealtimeAgentSettingsIn": { "properties": { "enabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled", "description": "Whether the realtime agent is enabled" } }, "type": "object", "title": "RealtimeAgentSettingsIn", "description": "Input model for creating/updating realtime agent settings" }, "VoiceWebhookConnection": { "properties": { "connection_id": { "type": "string", "format": "uuid", "title": "Connection Id" }, "webhook_type": { "$ref": "#/components/schemas/VoiceWebhookTypeEnum" } }, "type": "object", "required": [ "connection_id", "webhook_type" ], "title": "VoiceWebhookConnection" }, "VoiceWebhookTypeEnum": { "type": "string", "enum": [ "call_detail_record", "audio_file", "audio_stream" ], "title": "VoiceWebhookTypeEnum", "description": "Enum for voice webhook types." } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }