# IBM watsonx Orchestrate ADK: 2.x ## 2.x ### Release Notes - [What's new](https://developer.watson-orchestrate.ibm.com/release/release.md): See the latest improvements and bug fixes from the new version of the ADK. - [Known issues and limitations](https://developer.watson-orchestrate.ibm.com/release/knownissues.md): See the known issues and limitations, and learn how to circumvent them until they get fixed - [Troubleshooting](https://developer.watson-orchestrate.ibm.com/release/troubleshooting.md) ### Get Started - [Welcome to IBM watsonx Orchestrate Agent Development Kit](https://developer.watson-orchestrate.ibm.com/index.md) - [What is watsonx Orchestrate ADK](https://developer.watson-orchestrate.ibm.com/getting_started/what_is.md) - [Getting started with the ADK](https://developer.watson-orchestrate.ibm.com/getting_started/installing.md) - [Examples](https://developer.watson-orchestrate.ibm.com/getting_started/examples.md) - [Useful CLI commands](https://developer.watson-orchestrate.ibm.com/getting_started/cli.md) #### Tutorials - [Tutorial: Creating your first agent with the Agent builder](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_1_hello_world.md) - [Tutorial: Creating the Empower agent on Agent builder](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_2_arrows_internal_employees.md) - [Tutorial: Multi-language support](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_3_multi_language_support.md) - [Tutorial: Creating the Healthcare provider agent on Agent builder](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_4_healthcare_provider.md) - [Tutorial: Using watsonx Orchestrate and Langflow](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_langflow.md) - [Tutorial: Using watsonx Orchestrate and BeeAI Framework](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_beeai_framework.md) - [Advanced tutorials](https://developer.watson-orchestrate.ibm.com/tutorials/advanced_tutorials.md) ##### Configuring SSO for Workday - [Configuring SSO for Workday by using OAuth On-Behalf-Of flow](https://developer.watson-orchestrate.ibm.com/tutorials/workday_sso_connections/sso-diagram-concepts.md) - [Verify SSO authentication between Entra ID and Workday](https://developer.watson-orchestrate.ibm.com/tutorials/workday_sso_connections/verify-sso-authentication.md) - [Configuring Workday connection on watsonx Orchestrate](https://developer.watson-orchestrate.ibm.com/tutorials/workday_sso_connections/configure-workday-connection.md) ##### Customizing Embedded Chat - [Customizing embedded chat to match your brand](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_embedded_chat_overview.md) - [Tutorial: Customizing embedded chat to match your brand](https://developer.watson-orchestrate.ibm.com/tutorials/tutorial_embedded_chat_branding.md) ##### Voice Runtime Browser Test Application - [Overview](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/overview.md) - [Getting Started](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/building.md) - [Deploying Browser Changes to IBM Code Engine](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/deploy_to_ibm_code_engine.md) - [Troubleshooting](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/troubleshooting.md) ###### Reference - [Browser UI Tabs](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/browser.md) - [Storage](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/storage.md) - [Audio Format Specifications](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/audio_format.md) ###### APIs ###### Voice Runtime - [Voice Runtime WebSocket Proxy](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/voice-runtime/voice-runtime-websocket-proxy.md): WebSocket proxy endpoint for browser ↔ voice runtime audio and control messages. ###### Recordings - [Call Recording WebSocket](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/call-recording-websocket.md): WebSocket endpoint used by the voice runtime to stream call recordings. - [List all recordings](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/list-all-recordings.md) - [Get files in a recording](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/get-files-in-a-recording.md) - [Delete a recording](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/delete-a-recording.md) - [Get recording metadata](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/get-recording-metadata.md) - [Download role audio](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/download-role-audio.md) - [Download interleaved stereo audio](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/recordings/download-interleaved-stereo-audio.md) ###### CDR - [Receive CDR webhook](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/cdr/receive-cdr-webhook.md) - [List CDR reports](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/cdr/list-cdr-reports.md) - [Clear CDR reports](https://developer.watson-orchestrate.ibm.com/tutorials/testing_voice/apis/cdr/clear-cdr-reports.md) ##### Performance Guide - [watsonx Orchestrate Performance Guide](https://developer.watson-orchestrate.ibm.com/tutorials/performance/performance-guide-v2.md): Comprehensive guide to understanding, measuring, and optimizing performance in watsonx Orchestrate agents, flows, and tools - [Agent Performance Guide](https://developer.watson-orchestrate.ibm.com/tutorials/performance/performance-guide-v2-agent.md): Understanding, measuring, and optimizing Agent performance in watsonx Orchestrate - [Flow Performance Guide](https://developer.watson-orchestrate.ibm.com/tutorials/performance/performance-guide-v2-flow.md): Understanding, measuring, and optimizing Flow (wxO Agentic Workflow) performance in watsonx Orchestrate - [Tool Performance Guide](https://developer.watson-orchestrate.ibm.com/tutorials/performance/performance-guide-v2-tools.md): Understanding, measuring, and optimizing Tool performance in watsonx Orchestrate - [Knowledge Performance Guide](https://developer.watson-orchestrate.ibm.com/tutorials/performance/performance-guide-v2-knowledge.md): Understanding, measuring, and optimizing Knowledge runtime performance in watsonx Orchestrate ##### CI/CD Deployment - [wxO CI/CD Deployment Approach](https://developer.watson-orchestrate.ibm.com/tutorials/ci_cd/deployment-cicd-approach-1.md): A GitOps-inspired deployment strategy for watsonx Orchestrate agents, flows, tools, and knowledge bases using standard CI/CD pipelines - [wxO CI/CD Deployment Approach (Part 2)](https://developer.watson-orchestrate.ibm.com/tutorials/ci_cd/deployment-cicd-approach-2.md): Configuration specifications, knowledge-base deployment considerations, and secret handling patterns for wxO CI/CD workflows - [wxO CI/CD Deployment Approach (Part 3)](https://developer.watson-orchestrate.ibm.com/tutorials/ci_cd/deployment-cicd-approach-3.md): Inter-agent dependency patterns, testing gates, promotion and rollback workflows, security controls, and CLI deployment examples for wxO CI/CD - [wxO CI/CD Deployment Approach (Part 4)](https://developer.watson-orchestrate.ibm.com/tutorials/ci_cd/deployment-cicd-approach-4.md): Summary of core principles, Git-based versioning, two-tenant architecture, and implementation checklist for wxO CI/CD #### Configuring environments - [Configure access to remote environments](https://developer.watson-orchestrate.ibm.com/environment/initiate_environment.md) - [Getting credentials for your environments](https://developer.watson-orchestrate.ibm.com/environment/production_import.md) - [Operating in an air-gapped environment](https://developer.watson-orchestrate.ibm.com/environment/air_gap_environment.md) - [IBM Software Hub compatibility](https://developer.watson-orchestrate.ibm.com/environment/onprem_compatibility.md) ### Build - [IBM Agent Connect](https://developer.watson-orchestrate.ibm.com/partners/partners.md) #### Workspaces - [Overview](https://developer.watson-orchestrate.ibm.com/workspaces/overview.md) - [Workspace operations](https://developer.watson-orchestrate.ibm.com/workspaces/workspace_operations.md) #### Agents - [Overview](https://developer.watson-orchestrate.ibm.com/agents/overview.md) - [Importing and deploying agents](https://developer.watson-orchestrate.ibm.com/agents/import_agent.md) - [Managing agents](https://developer.watson-orchestrate.ibm.com/agents/manage_agent.md) ##### Authoring agents - [Authoring native agents](https://developer.watson-orchestrate.ibm.com/agents/build_agent.md) - [Connect to external agents](https://developer.watson-orchestrate.ibm.com/agents/connect_agent.md) - [Authoring agents with the Orchestrate AI Builder](https://developer.watson-orchestrate.ibm.com/ai_builder/creating_agent.md) - [Agent descriptions and instructions](https://developer.watson-orchestrate.ibm.com/agents/descriptions.md) - [Agent development with Skills specifications](https://developer.watson-orchestrate.ibm.com/agents/skills.md) ###### Choosing the agent style - [Choosing the agent style](https://developer.watson-orchestrate.ibm.com/agents/agent_styles.md) - [Migrating to ReAct Core agent style](https://developer.watson-orchestrate.ibm.com/agents/agent_styles_migration.md) ##### Agent design - [Overview](https://developer.watson-orchestrate.ibm.com/agents/agent_design/overview.md) - [Foundational architecture considerations](https://developer.watson-orchestrate.ibm.com/agents/agent_design/foundational_architecture.md) - [Agent or Agentic Workflow? A decision guide](https://developer.watson-orchestrate.ibm.com/agents/agent_design/agentic_workflow_decision_guide.md): How to decide whether to use an Agent, an Agentic Workflow, or call a workflow directly — and how to choose the right integration pattern for your use case. - [Tooling & scalability considerations](https://developer.watson-orchestrate.ibm.com/agents/agent_design/tooling_scalability.md) - [Knowledge and document processing considerations](https://developer.watson-orchestrate.ibm.com/agents/agent_design/knowledge_processing.md) - [MCP tools & integration considerations](https://developer.watson-orchestrate.ibm.com/agents/agent_design/mcp_integration.md) - [Bob skills](https://developer.watson-orchestrate.ibm.com/agents/agent_design/wxo_skills.md) - [Guidelines: performance, context, and when to use them](https://developer.watson-orchestrate.ibm.com/agents/agent_design/guidelines.md) #### Agent skills - [Agent skills](https://developer.watson-orchestrate.ibm.com/agent_skills/overview.md) - [Managing agent skills](https://developer.watson-orchestrate.ibm.com/agent_skills/manage_skills.md) ##### Tutorial - [Overview](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/overview.md) - [Tools](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/tools.md) - [Operations assistant](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/agent.md) - [Order placement skill](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/order_placement.md) - [Inventory check skill](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/inventory_check.md) - [Sample query walkthrough](https://developer.watson-orchestrate.ibm.com/agent_skills/multi/sample_query.md) #### Large Language Models (LLMs) - [Choosing your LLM](https://developer.watson-orchestrate.ibm.com/llm/getting_started_llm.md) - [Enabling premier models](https://developer.watson-orchestrate.ibm.com/llm/enable_premier_models.md) - [Using GPT-5.4](https://developer.watson-orchestrate.ibm.com/llm/gpt54.md) - [Migrating agents from Llama to GPT-OSS-120B](https://developer.watson-orchestrate.ibm.com/llm/migrating_to_gpt_oss.md) - [Managing virtual models](https://developer.watson-orchestrate.ibm.com/llm/managing_llm.md) - [Configuring model policies (Public preview)](https://developer.watson-orchestrate.ibm.com/llm/model_policies.md) - [Enabling watsonx/* LLMs](https://developer.watson-orchestrate.ibm.com/llm/watsonx_models.md) #### Agentic Workflows - [Understanding agentic workflows](https://developer.watson-orchestrate.ibm.com/tools/flows/overview.md) - [Building agentic workflows](https://developer.watson-orchestrate.ibm.com/tools/flows/building_flow.md) - [Configuring callbacks](https://developer.watson-orchestrate.ibm.com/tools/flows/callback.md) - [Configuring multi-user activities](https://developer.watson-orchestrate.ibm.com/tools/flows/multi_user.md) - [Masking sensitive data](https://developer.watson-orchestrate.ibm.com/tools/flows/masking_sensitive_data.md) - [Mapping inputs and outputs](https://developer.watson-orchestrate.ibm.com/tools/flows/data_map.md) - [Testing agentic workflow](https://developer.watson-orchestrate.ibm.com/tools/flows/testing_flow.md) - [Running agentic workflows with MCP (Public Preview)](https://developer.watson-orchestrate.ibm.com/tools/flows/mcp_workflows.md) - [Agentic workflow expressions](https://developer.watson-orchestrate.ibm.com/tools/flows/flow_expression.md) - [Handling errors](https://developer.watson-orchestrate.ibm.com/tools/flows/error_handling.md) ##### Workflow nodes - [Agent node](https://developer.watson-orchestrate.ibm.com/tools/flows/agent_node.md) - [Tool node](https://developer.watson-orchestrate.ibm.com/tools/flows/tool_node.md) - [Script node](https://developer.watson-orchestrate.ibm.com/tools/flows/script_node.md) - [Branch node](https://developer.watson-orchestrate.ibm.com/tools/flows/branch_node.md) - [Parallel node](https://developer.watson-orchestrate.ibm.com/tools/flows/parallel_node.md) - [Foreach node](https://developer.watson-orchestrate.ibm.com/tools/flows/foreach_node.md) - [Decisions node](https://developer.watson-orchestrate.ibm.com/tools/flows/decisions_node.md) - [Generative prompt node](https://developer.watson-orchestrate.ibm.com/tools/flows/genai_node.md) - [User activity node](https://developer.watson-orchestrate.ibm.com/tools/flows/user_activities_node.md) - [Timer node](https://developer.watson-orchestrate.ibm.com/tools/flows/timer_node.md) ###### Document processing - [Document field extractor node](https://developer.watson-orchestrate.ibm.com/tools/flows/document_extractor.md) - [Document classifier node](https://developer.watson-orchestrate.ibm.com/tools/flows/document_classifier.md) - [Document text extractor node](https://developer.watson-orchestrate.ibm.com/tools/flows/document_processing_nodes.md) ##### Multi-language support - [Multi-language support overview](https://developer.watson-orchestrate.ibm.com/tools/flows/multi_language_overview.md) - [Configuring target locales](https://developer.watson-orchestrate.ibm.com/tools/flows/multi_language_configuration.md) - [Managing translations for agentic workflows](https://developer.watson-orchestrate.ibm.com/tools/flows/multi_language_translations.md) #### Tools - [Overview](https://developer.watson-orchestrate.ibm.com/tools/overview.md) - [Authoring OpenAPI based tools](https://developer.watson-orchestrate.ibm.com/tools/create_openapi_tool.md) - [Managing tools](https://developer.watson-orchestrate.ibm.com/tools/manage_tool.md) - [Logging behavior for Python tools in watsonx Orchestrate](https://developer.watson-orchestrate.ibm.com/tools/log_behavior.md) ##### Authoring Python-Based Tools - [Authoring Python-Based Tools](https://developer.watson-orchestrate.ibm.com/tools/create_tool.md) - [Writing tool schemas for Python tools](https://developer.watson-orchestrate.ibm.com/tools/tool_schemas.md) - [Tool response structure and annotations](https://developer.watson-orchestrate.ibm.com/tools/tool_response_structure.md): Python tools can return structured responses with rich content, widgets, and metadata. - [Widget integration for Python tools](https://developer.watson-orchestrate.ibm.com/tools/widget_integration.md): Widgets provide interactive UI components in tool responses. - [Python Dependency Management in watsonx Orchestrate](https://developer.watson-orchestrate.ibm.com/tools/python_dependency_management.md) ##### Authoring Langflow tools - [Overview](https://developer.watson-orchestrate.ibm.com/langflow/overview.md) - [Langflow versions](https://developer.watson-orchestrate.ibm.com/langflow/langflow_versions.md) - [Prerequisites and limitations](https://developer.watson-orchestrate.ibm.com/langflow/prerequisistes_and_limitations.md) - [Building Langflow tools](https://developer.watson-orchestrate.ibm.com/langflow/building.md) - [Binding global variables to connections](https://developer.watson-orchestrate.ibm.com/langflow/binding_variables.md) - [Importing Langflow tools](https://developer.watson-orchestrate.ibm.com/langflow/import.md) #### Toolkits - [Overview](https://developer.watson-orchestrate.ibm.com/tools/toolkits/overview.md) - [Choosing a tool type](https://developer.watson-orchestrate.ibm.com/tools/toolkits/choosing_tool_type.md) - [Importing local MCP toolkits](https://developer.watson-orchestrate.ibm.com/tools/toolkits/local_mcp_toolkits.md) - [Importing remote MCP toolkits](https://developer.watson-orchestrate.ibm.com/tools/toolkits/remote_mcp_toolkits.md) - [Importing Python toolkits](https://developer.watson-orchestrate.ibm.com/tools/toolkits/python_toolkits.md) - [Migrating to Python toolkits](https://developer.watson-orchestrate.ibm.com/tools/toolkits/migrating_to_toolkits.md) - [Managing toolkits](https://developer.watson-orchestrate.ibm.com/tools/toolkits/manage_toolkits.md) #### Connections - [Why use connections](https://developer.watson-orchestrate.ibm.com/connections/overview.md) - [Creating connections](https://developer.watson-orchestrate.ibm.com/connections/build_connections.md) - [OAuth2 token lifecycle and required scopes](https://developer.watson-orchestrate.ibm.com/connections/oauth2_token_lifecycle.md) - [Managing connections](https://developer.watson-orchestrate.ibm.com/connections/managing_connections.md) - [Managing connections to Customer Care platforms](https://developer.watson-orchestrate.ibm.com/connections/customer_care/customer_care_platform.md) ##### Associating connections - [Associating connections to OpenAPI tools](https://developer.watson-orchestrate.ibm.com/connections/associate_connection_to_tool/openapi_connections.md) - [Associating connections to Python tools](https://developer.watson-orchestrate.ibm.com/connections/associate_connection_to_tool/python_connections.md) - [Associating connections to Custom agents](https://developer.watson-orchestrate.ibm.com/connections/connections_for_custom_agents.md) #### Controls - [Managing controls](https://developer.watson-orchestrate.ibm.com/controls/managing_controls.md): Use the ADK CLI to create, update, and remove policy controls that enforce guardrails and PII filtering on agents, tools, and models. #### Conversation - [Sending context to conversations](https://developer.watson-orchestrate.ibm.com/conversation/context_variables.md): Use context variables to create more personalized, context-aware interactions by providing the agent with relevant data about the user or the environment, such as user ID, role, tenant, locale, or session-specific values from upstream systems. #### Knowledge Bases - [Overview](https://developer.watson-orchestrate.ibm.com/knowledge_base/overview.md) - [Creating knowledge bases](https://developer.watson-orchestrate.ibm.com/knowledge_base/build_kb.md) - [Importing knowledge bases](https://developer.watson-orchestrate.ibm.com/knowledge_base/deploy_kb.md) - [Managing knowledge bases](https://developer.watson-orchestrate.ibm.com/knowledge_base/manage_kb.md) #### Plug-ins - [Plug-ins](https://developer.watson-orchestrate.ibm.com/plugins/plugins.md) - [OpenAPI Plug-ins](https://developer.watson-orchestrate.ibm.com/plugins/openapi_plugin.md) #### Channels - [Overview](https://developer.watson-orchestrate.ibm.com/channels/overview.md) - [Establishing Channels](https://developer.watson-orchestrate.ibm.com/channels/establishing_channels.md) ##### Channel types - [Web chat](https://developer.watson-orchestrate.ibm.com/channels/web_chat.md) - [Twilio WhatsApp](https://developer.watson-orchestrate.ibm.com/channels/twilio_whatsapp.md) - [Twilio SMS](https://developer.watson-orchestrate.ibm.com/channels/twilio_sms.md) - [Slack](https://developer.watson-orchestrate.ibm.com/channels/slack.md) - [Genesys Bot Connector](https://developer.watson-orchestrate.ibm.com/channels/genesys_bot_connector.md) - [Microsoft Teams](https://developer.watson-orchestrate.ibm.com/channels/microsoft_teams.md) - [Facebook Messenger](https://developer.watson-orchestrate.ibm.com/channels/facebook_messenger.md) #### Phone - [Overview](https://developer.watson-orchestrate.ibm.com/phone/overview.md) - [Adding Phone Configurations](https://developer.watson-orchestrate.ibm.com/phone/adding_phone_config.md) #### Voice - [Managing voice configuration](https://developer.watson-orchestrate.ibm.com/voice/managing_voice.md) - [Adding voice to an agent](https://developer.watson-orchestrate.ibm.com/voice/adding_voice_to_agent.md) #### Scheduling - [Overview](https://developer.watson-orchestrate.ibm.com/scheduling/overview.md) - [Enabling scheduling for agentic workflows and agents](https://developer.watson-orchestrate.ibm.com/scheduling/enabling.md) - [Migrating to the new scheduling approach](https://developer.watson-orchestrate.ibm.com/scheduling/migrating.md) ### Deploy #### Embedded chat - [Overview](https://developer.watson-orchestrate.ibm.com/webchat/overview.md) - [Release notes for embedded chat](https://developer.watson-orchestrate.ibm.com/webchat/changelog.md) - [Getting started](https://developer.watson-orchestrate.ibm.com/webchat/get_started.md) - [Thumbs-up and thumbs-down feedback](https://developer.watson-orchestrate.ibm.com/webchat/events_feedback.md) - [Context variables](https://developer.watson-orchestrate.ibm.com/webchat/context_variables.md) ##### Customize message flow - [Customize message flow](https://developer.watson-orchestrate.ibm.com/webchat/customize_message_flow.md) - [Handling user input with pre:send event](https://developer.watson-orchestrate.ibm.com/webchat/events/handling-user-input.md) ##### Instance methods - [Instance methods](https://developer.watson-orchestrate.ibm.com/webchat/instance_methods.md) ###### Chat state - [getLocale()](https://developer.watson-orchestrate.ibm.com/webchat/methods/getLocale.md) ###### Events - [off()](https://developer.watson-orchestrate.ibm.com/webchat/methods/off.md) - [on()](https://developer.watson-orchestrate.ibm.com/webchat/methods/on.md) - [once()](https://developer.watson-orchestrate.ibm.com/webchat/methods/once.md) ###### Message - [doAutoScroll()](https://developer.watson-orchestrate.ibm.com/webchat/methods/doAutoScroll.md) - [loadThreadById()](https://developer.watson-orchestrate.ibm.com/webchat/methods/loadThreadById.md) - [restartConversation()](https://developer.watson-orchestrate.ibm.com/webchat/methods/restartConversation.md) - [scrollToMessage()](https://developer.watson-orchestrate.ibm.com/webchat/methods/scrollToMessage.md) - [send()](https://developer.watson-orchestrate.ibm.com/webchat/methods/send.md) - [updateMessageStateUserDefined()](https://developer.watson-orchestrate.ibm.com/webchat/methods/updateMessageStateUserDefined.md) ###### Security and identity - [destroy()](https://developer.watson-orchestrate.ibm.com/webchat/methods/destroy.md) - [updateAuthToken()](https://developer.watson-orchestrate.ibm.com/webchat/methods/updateAuthToken.md) ###### User interface - [changeView()](https://developer.watson-orchestrate.ibm.com/webchat/methods/changeView.md) - [getCustomHeaderItems()](https://developer.watson-orchestrate.ibm.com/webchat/methods/getCustomHeaderItems.md) - [getWriteableElement()](https://developer.watson-orchestrate.ibm.com/webchat/methods/getWriteableElement.md) - [updateCustomHeaderItems()](https://developer.watson-orchestrate.ibm.com/webchat/methods/updateCustomHeaderItems.md) - [updateWelcomeScreen()](https://developer.watson-orchestrate.ibm.com/webchat/methods/updateWelcomeScreen.md) - [updateLocale()](https://developer.watson-orchestrate.ibm.com/webchat/methods/updateLocale.md) ##### Events - [Events](https://developer.watson-orchestrate.ibm.com/webchat/events.md) ###### Conversation events - [pre:restartConversation](https://developer.watson-orchestrate.ibm.com/webchat/events/preRestartConversation.md) - [restartConversation](https://developer.watson-orchestrate.ibm.com/webchat/events/restartConversation.md) - [pre:threadLoaded](https://developer.watson-orchestrate.ibm.com/webchat/events/preThreadLoaded.md) ###### Customization events - [userDefinedResponse](https://developer.watson-orchestrate.ibm.com/webchat/events/userDefinedResponse.md) - [customEvent](https://developer.watson-orchestrate.ibm.com/webchat/events/customEvent.md) ###### Feedback events - [feedback](https://developer.watson-orchestrate.ibm.com/webchat/events/feedback.md) ###### Lifecycle events - [chat:ready](https://developer.watson-orchestrate.ibm.com/webchat/events/chatReady.md) ###### Message events - [pre:send](https://developer.watson-orchestrate.ibm.com/webchat/events/preSend.md) - [send](https://developer.watson-orchestrate.ibm.com/webchat/events/send.md) - [pre:stream:delta](https://developer.watson-orchestrate.ibm.com/webchat/events/preStreamDelta.md) - [pre:receive](https://developer.watson-orchestrate.ibm.com/webchat/events/preReceive.md) - [receive](https://developer.watson-orchestrate.ibm.com/webchat/events/receive.md) ###### Security events - [authTokenNeeded](https://developer.watson-orchestrate.ibm.com/webchat/events/authTokenNeeded.md) ###### View events - [view:pre:change](https://developer.watson-orchestrate.ibm.com/webchat/events/viewPreChange.md) - [view:change](https://developer.watson-orchestrate.ibm.com/webchat/events/viewChange.md) - [view:properties:pre:change](https://developer.watson-orchestrate.ibm.com/webchat/events/viewPropertiesPreChange.md) - [view:properties:change](https://developer.watson-orchestrate.ibm.com/webchat/events/viewPropertiesChange.md) ##### UI configuration - [UI configuration](https://developer.watson-orchestrate.ibm.com/webchat/ui_configuration.md) - [Customization guidelines](https://developer.watson-orchestrate.ibm.com/webchat/customization_guidelines.md) ### Analyze #### Evaluation Framework - [Overview](https://developer.watson-orchestrate.ibm.com/evaluate/overview.md) - [Creating test cases for evaluation](https://developer.watson-orchestrate.ibm.com/evaluate/create_data.md) - [Evaluating agents and tools](https://developer.watson-orchestrate.ibm.com/evaluate/evaluate.md) - [Quick evaluation of agents and tools](https://developer.watson-orchestrate.ibm.com/evaluate/quick_eval.md) - [Analyzing agents and tools](https://developer.watson-orchestrate.ibm.com/evaluate/analyze.md) - [LLM agent vulnerability testing](https://developer.watson-orchestrate.ibm.com/evaluate/llm_vulnerability.md) - [Rubric Evaluations](https://developer.watson-orchestrate.ibm.com/evaluate/rubric.md) #### Langfuse - [Monitoring your LLMs with Langfuse](https://developer.watson-orchestrate.ibm.com/llm/observability.md) #### Traces - [Overview](https://developer.watson-orchestrate.ibm.com/traces/overview.md) - [Using traces with ADK CLI](https://developer.watson-orchestrate.ibm.com/traces/traces_with_cli.md) - [Using traces with Python](https://developer.watson-orchestrate.ibm.com/traces/traces_with_python.md) ##### Exporting traces from external agents - [Exporting observability traces with Observability SDK](https://developer.watson-orchestrate.ibm.com/traces/observability-sdk.md): Surface execution traces from LangGraph agents running outside watsonx Orchestrate in the Agent Analytics dashboard by using decorator-based instrumentation. - [Exporting observability traces with OpenTelemetry](https://developer.watson-orchestrate.ibm.com/traces/otel-export.md): Surface execution traces from agents running outside watsonx Orchestrate in the Agent Analytics dashboard by using any agentic framework, without requiring a watsonx Orchestrate SDK dependency. ### Developer experience #### Developer Edition - [What is watsonx Orchestrate Developer Edition?](https://developer.watson-orchestrate.ibm.com/developer_edition/wxOde_overview.md) - [Subscribing to security bulletins](https://developer.watson-orchestrate.ibm.com/developer_edition/security_bulletins.md) ##### Installing Developer Edition - [Installing watsonx Orchestrate Developer Edition](https://developer.watson-orchestrate.ibm.com/developer_edition/wxOde_setup.md) - [Using custom watsonx Orchestrate Developer Edition docker file](https://developer.watson-orchestrate.ibm.com/developer_edition/custom_yaml.md) - [Creating custom Developer Edition image registry](https://developer.watson-orchestrate.ibm.com/developer_edition/custom_registry.md) ##### Managing Developer Edition - [Managing watsonx Orchestrate Developer Edition UI](https://developer.watson-orchestrate.ibm.com/developer_edition/manage_ui.md) - [Managing watsonx Orchestrate Developer Edition server](https://developer.watson-orchestrate.ibm.com/developer_edition/manage_local_server.md) ##### Developer Edition API - [Authenticating with the watsonx Orchestrate Developer Edition API](https://developer.watson-orchestrate.ibm.com/developer_edition/api_authentication.md) ###### Orchestrate Agent - [Chat With Orchestrate Assistant As Stream](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/chat-with-orchestrate-assistant-as-stream.md) - [List Orchestrate Assistant Runs](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/list-orchestrate-assistant-runs.md) - [Chat With Orchestrate Assistant](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/chat-with-orchestrate-assistant.md) - [Upload To S3](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/upload-to-s3.md) - [Cancel An Orchestrate Assistant Run](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/cancel-an-orchestrate-assistant-run.md) - [Get Orchestrate Assistant Run](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/get-orchestrate-assistant-run.md) - [Get Orchestrate Assistant Run Events](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/get-orchestrate-assistant-run-events.md) - [Chat With Agents](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-agent/chat-with-agents.md) ###### Assistants Runs - [List Assistant Runs](https://developer.watson-orchestrate.ibm.com/apis/assistants-runs/list-assistant-runs.md) - [Run Assistant](https://developer.watson-orchestrate.ibm.com/apis/assistants-runs/run-assistant.md) - [Get Assistant Run By Id](https://developer.watson-orchestrate.ibm.com/apis/assistants-runs/get-assistant-run-by-id.md) ###### Custom Assistants - [List Custom Assistants](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/list-custom-assistants.md) - [Create Custom Assistant](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/create-custom-assistant.md) - [Get Custom Assistant By Id](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/get-custom-assistant-by-id.md) - [Delete Custom Assistant](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/delete-custom-assistant.md) - [Update Custom Assistant](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/update-custom-assistant.md) - [List Custom Assistant Files](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/list-custom-assistant-files.md) - [Upload File To A Custom Assistant](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/upload-file-to-a-custom-assistant.md) - [Delete Custom Assistant File By Id](https://developer.watson-orchestrate.ibm.com/apis/custom-assistants/delete-custom-assistant-file-by-id.md) ###### watsonx Assistant - [List Watsonx Assistant Instances](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/list-watsonx-assistant-instances.md) - [Register Watsonx Assistant Instance](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/register-watsonx-assistant-instance.md) - [Get Watsonx Assistant Instance](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/get-watsonx-assistant-instance.md) - [Delete Watsonx Assistant Instance](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/delete-watsonx-assistant-instance.md) - [Update Watsonx Assistant Instance](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/update-watsonx-assistant-instance.md) - [Fetch List Of Assistants Available In Wxa Instance](https://developer.watson-orchestrate.ibm.com/apis/watsonx-assistant/fetch-list-of-assistants-available-in-wxa-instance.md) ###### External Chat Agents - [List Registered External Chat Completions Agants.](https://developer.watson-orchestrate.ibm.com/apis/external-chat-agents/list-registered-external-chat-completions-agants.md) - [Register An External Chat Completions Agent.](https://developer.watson-orchestrate.ibm.com/apis/external-chat-agents/register-an-external-chat-completions-agent.md) - [Get A Registered External Chat Completions Agent By Id.](https://developer.watson-orchestrate.ibm.com/apis/external-chat-agents/get-a-registered-external-chat-completions-agent-by-id.md) - [Delete A Registered External Chat Completions Agent.](https://developer.watson-orchestrate.ibm.com/apis/external-chat-agents/delete-a-registered-external-chat-completions-agent.md) - [Update A Registered External Chat Completions Agent.](https://developer.watson-orchestrate.ibm.com/apis/external-chat-agents/update-a-registered-external-chat-completions-agent.md) ###### A2A Protocol - [Get supported A2A protocol versions](https://developer.watson-orchestrate.ibm.com/apis/a2a-protocol/get-supported-a2a-protocol-versions.md): Returns the list of supported A2A protocol versions for a specific role (client or server). ###### Message Threads - [List Message Threads](https://developer.watson-orchestrate.ibm.com/apis/message-threads/list-message-threads.md) - [Create Message Thread](https://developer.watson-orchestrate.ibm.com/apis/message-threads/create-message-thread.md) - [Get Message Thread By Id](https://developer.watson-orchestrate.ibm.com/apis/message-threads/get-message-thread-by-id.md) - [Delete Message Thread](https://developer.watson-orchestrate.ibm.com/apis/message-threads/delete-message-thread.md) - [Update Message Thread](https://developer.watson-orchestrate.ibm.com/apis/message-threads/update-message-thread.md) - [List Messages](https://developer.watson-orchestrate.ibm.com/apis/message-threads/list-messages.md) - [Create Message](https://developer.watson-orchestrate.ibm.com/apis/message-threads/create-message.md) - [Get Message By Id](https://developer.watson-orchestrate.ibm.com/apis/message-threads/get-message-by-id.md) - [Delete Message](https://developer.watson-orchestrate.ibm.com/apis/message-threads/delete-message.md) - [Update Message](https://developer.watson-orchestrate.ibm.com/apis/message-threads/update-message.md) ###### Catalog Management - [Export Catalog Resources](https://developer.watson-orchestrate.ibm.com/apis/catalog-management/export-catalog-resources.md) - [List All Apps Available In Catalog](https://developer.watson-orchestrate.ibm.com/apis/catalog-management/list-all-apps-available-in-catalog.md): 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. - [List All Skills Available From Catalog, Under An Application](https://developer.watson-orchestrate.ibm.com/apis/catalog-management/list-all-skills-available-from-catalog-under-an-application.md): 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. ###### Tenant Management - [Fetch Tenants](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/fetch-tenants.md) - [Create Tenant](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/create-tenant.md) - [Get Tenant By Id](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/get-tenant-by-id.md) - [Delete Tenant By Id](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/delete-tenant-by-id.md) - [Update Tenant](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/update-tenant.md) - [Sync Tenant Permission](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/sync-tenant-permission.md) - [Revoke Tenant Permissions](https://developer.watson-orchestrate.ibm.com/apis/tenant-management/revoke-tenant-permissions.md) ###### Provisioning Lite - [Provision](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/provision.md) - [Deprovision](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/deprovision.md) - [Add User](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/add-user.md) - [Delete User](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/delete-user.md) - [Update User](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/update-user.md) - [Monitor Instance](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/monitor-instance.md) - [Propagate Tenant And User Events](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/propagate-tenant-and-user-events.md) - [Rebroadcast](https://developer.watson-orchestrate.ibm.com/apis/provisioning-lite/rebroadcast.md) ###### Embed settings - [Get Config](https://developer.watson-orchestrate.ibm.com/apis/embed-settings/get-config.md) - [Create Config](https://developer.watson-orchestrate.ibm.com/apis/embed-settings/create-config.md) - [Generate Key Pair](https://developer.watson-orchestrate.ibm.com/apis/embed-settings/generate-key-pair.md) ###### User Profiles - [Get My Profile](https://developer.watson-orchestrate.ibm.com/apis/user-profiles/get-my-profile.md) - [Update Profile Settings](https://developer.watson-orchestrate.ibm.com/apis/user-profiles/update-profile-settings.md) ###### Completions - [Create Completion](https://developer.watson-orchestrate.ibm.com/apis/completions/create-completion.md) - [Create Chat Completion](https://developer.watson-orchestrate.ibm.com/apis/completions/create-chat-completion.md) ###### Background Tasks - [List Background Tasks](https://developer.watson-orchestrate.ibm.com/apis/background-tasks/list-background-tasks.md) - [Fetch Background Task](https://developer.watson-orchestrate.ibm.com/apis/background-tasks/fetch-background-task.md) - [Abort Background Task](https://developer.watson-orchestrate.ibm.com/apis/background-tasks/abort-background-task.md) ###### Auth - [Register A User Profile](https://developer.watson-orchestrate.ibm.com/apis/auth/register-a-user-profile.md) - [Login For Token](https://developer.watson-orchestrate.ibm.com/apis/auth/login-for-token.md) ###### Orchestrate Assistant - [Callback](https://developer.watson-orchestrate.ibm.com/apis/orchestrate-assistant/callback.md) ###### Notifications - [Post A Notification](https://developer.watson-orchestrate.ibm.com/apis/notifications/post-a-notification.md) - [Fetch All Notifications For A User By Tenant](https://developer.watson-orchestrate.ibm.com/apis/notifications/fetch-all-notifications-for-a-user-by-tenant.md) - [Post A Notification](https://developer.watson-orchestrate.ibm.com/apis/notifications/post-a-notification-1.md) ###### IBM unique ID mapping - [Get Unique Id Mapping](https://developer.watson-orchestrate.ibm.com/apis/ibm-unique-id-mapping/get-unique-id-mapping.md) - [Create Tenant Unique Id Mapping](https://developer.watson-orchestrate.ibm.com/apis/ibm-unique-id-mapping/create-tenant-unique-id-mapping.md) - [Delete Mapping](https://developer.watson-orchestrate.ibm.com/apis/ibm-unique-id-mapping/delete-mapping.md) ###### Prompts - [Get Prompts](https://developer.watson-orchestrate.ibm.com/apis/prompts/get-prompts.md) - [Create Or Update Prompt](https://developer.watson-orchestrate.ibm.com/apis/prompts/create-or-update-prompt.md) - [Delete All Prompts](https://developer.watson-orchestrate.ibm.com/apis/prompts/delete-all-prompts.md) - [Get A Prompt](https://developer.watson-orchestrate.ibm.com/apis/prompts/get-a-prompt.md) - [Delete Prompt](https://developer.watson-orchestrate.ibm.com/apis/prompts/delete-prompt.md) ###### Artifact Management - [Fetch List Of Apps Added In Archer](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/fetch-list-of-apps-added-in-archer.md): 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. - [Fetch List Of Skills Added In Archer](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/fetch-list-of-skills-added-in-archer.md): 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. - [Add Skill To Archer](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/add-skill-to-archer.md): 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. - [Edit Skill : Update Routing-Description](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/edit-skill.md): 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. - [Remove Skill From Archer](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/remove-skill-from-archer.md): 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. - [Update Skill In Archer](https://developer.watson-orchestrate.ibm.com/apis/artifact-management/update-skill-in-archer.md): 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. ###### all journey types - [List All Possible Journeys](https://developer.watson-orchestrate.ibm.com/apis/all-journey-types/list-all-possible-journeys.md) ###### Connections - [Get Connections](https://developer.watson-orchestrate.ibm.com/apis/connections/get-connections.md): Retrieve a connection based on the provided app ID and shared flag. - [Create Connection](https://developer.watson-orchestrate.ibm.com/apis/connections/create-connection.md): Creates a new connection with validation, duplicate checking, and OAuth2 processing. - [Delete Connection](https://developer.watson-orchestrate.ibm.com/apis/connections/delete-connection.md) - [Oauth Callback](https://developer.watson-orchestrate.ibm.com/apis/connections/oauth-callback.md) - [Get List Of Connections](https://developer.watson-orchestrate.ibm.com/apis/connections/get-list-of-connections.md): Retrieve a connection based on the provided app ID. ###### Tools - [Fetch Tools](https://developer.watson-orchestrate.ibm.com/apis/tools/fetch-tools.md) - [Create A Tool](https://developer.watson-orchestrate.ibm.com/apis/tools/create-a-tool.md) - [Get Tool By Id](https://developer.watson-orchestrate.ibm.com/apis/tools/get-tool-by-id.md) - [Patch A Tool](https://developer.watson-orchestrate.ibm.com/apis/tools/patch-a-tool.md) - [Delete A Tool By Id](https://developer.watson-orchestrate.ibm.com/apis/tools/delete-a-tool-by-id.md) - [Upload Tools Supporting Artifact](https://developer.watson-orchestrate.ibm.com/apis/tools/upload-tools-supporting-artifact.md) - [Download Tools Supporting Artifact](https://developer.watson-orchestrate.ibm.com/apis/tools/download-tools-supporting-artifact.md) - [Create From Template](https://developer.watson-orchestrate.ibm.com/apis/tools/create-from-template.md) - [Post Tool Response From The Async Tool](https://developer.watson-orchestrate.ibm.com/apis/tools/post-tool-response-from-the-async-tool.md) - [Search For Sub Correlation Object And Create If It Does Not Exists](https://developer.watson-orchestrate.ibm.com/apis/tools/search-for-sub-correlation-object-and-create-if-it-does-not-exists.md) ###### Tools V2 - [Fetch Tools](https://developer.watson-orchestrate.ibm.com/apis/tools-v2/fetch-tools.md) ###### LLM Analytics - [Get Llm Analytics Config](https://developer.watson-orchestrate.ibm.com/apis/llm-analytics/get-llm-analytics-config.md): Get LLM analytics tool integration status - [Create Or Update Llm Analytics Config](https://developer.watson-orchestrate.ibm.com/apis/llm-analytics/create-or-update-llm-analytics-config.md): Create or update LLM analytics tool integration - [Delete Llm Analytics Config](https://developer.watson-orchestrate.ibm.com/apis/llm-analytics/delete-llm-analytics-config.md): Delete LLM analytics tool integration ###### Agents - [List Registered Agents](https://developer.watson-orchestrate.ibm.com/apis/agents/list-registered-agents.md): Lists all registered agents. - [Register A New Agent](https://developer.watson-orchestrate.ibm.com/apis/agents/register-a-new-agent.md): Registers a new agent in the system. - [Get A Registered Agent By Id.](https://developer.watson-orchestrate.ibm.com/apis/agents/get-a-registered-agent-by-id.md): Retrieves details of a specific agent by its id. - [Delete A Registered Agent.](https://developer.watson-orchestrate.ibm.com/apis/agents/delete-a-registered-agent.md): Deletes a registered agent by id. - [Update A Registered Agent](https://developer.watson-orchestrate.ibm.com/apis/agents/update-a-registered-agent.md): Updates an existing agent by id. - [Get List Of Tools Of An Agent Specific To A Version](https://developer.watson-orchestrate.ibm.com/apis/agents/get-list-of-tools-of-an-agent-specific-to-a-version.md): Retrieves details of a specific agent by its id. - [Get Template Creation Status](https://developer.watson-orchestrate.ibm.com/apis/agents/get-template-creation-status.md): Get the creation status for an agent and its components. - [Create An Agent From A Template.](https://developer.watson-orchestrate.ibm.com/apis/agents/create-an-agent-from-a-template.md): Creates a new agent and its dependencies from a template. - [Get List Of Connections From All Tools Associated With An Agent](https://developer.watson-orchestrate.ibm.com/apis/agents/get-list-of-connections-from-all-tools-associated-with-an-agent.md): 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. - [Get List Of Connections From All Tools Associated With An Agent](https://developer.watson-orchestrate.ibm.com/apis/agents/get-list-of-connections-from-all-tools-associated-with-an-agent-1.md): 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. ###### Agents V2 - [List Registered Agents.](https://developer.watson-orchestrate.ibm.com/apis/agents-v2/list-registered-agents.md): Lists all registered agents. - [List Unified Agents.](https://developer.watson-orchestrate.ibm.com/apis/agents-v2/list-unified-agents.md): Lists all registered agents. ###### Agent Releases - [List Versioned Agents By Environment Name](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/list-versioned-agents-by-environment-name.md): Lists all registered agents. - [Get List Of Agent Versions By Id.](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/get-list-of-agent-versions-by-id.md): Lists all agent versions by agentid. - [Release An Agent By Id](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/release-an-agent-by-id.md): Release an agent by id. - [Get The Status Of The Agent Deployment](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/get-the-status-of-the-agent-deployment.md): Get status of the current deployed agent version. - [Get An Agent Version By Id And Version](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/get-an-agent-version-by-id-and-version.md): Get an agent version by id and version. - [Delete Version Of A Released Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/delete-version-of-a-released-agent.md): Delete version of a released agent by id and version. - [Undeploy A Released Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/undeploy-a-released-agent.md): Undeploy a released agent by id and version. - [Switch Current Agent Version Of An Environment To A New Version.](https://developer.watson-orchestrate.ibm.com/apis/agent-releases/switch-current-agent-version-of-an-environment-to-a-new-version.md): Switch current agent version of an environment to a new version. ###### Agent Release Environments - [List All Environments Of An Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-release-environments/list-all-environments-of-an-agent.md): List all environments of an agent. - [Create An Environment For An Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-release-environments/create-an-environment-for-an-agent.md): Registers a new environment for an agent. - [Get A Specific Environment For An Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-release-environments/get-a-specific-environment-for-an-agent.md): Get a specific environment for an agent. - [Delete An Environment Of An Agent By Id](https://developer.watson-orchestrate.ibm.com/apis/agent-release-environments/delete-an-environment-of-an-agent-by-id.md): Delete an environment of an agent by id. - [Update An Environment Of An Agent By Id](https://developer.watson-orchestrate.ibm.com/apis/agent-release-environments/update-an-environment-of-an-agent-by-id.md): Update an environment of an agent by id. ###### Agent Chat Starter Settings - [Get Chat Starter Settings For A Registered Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-chat-starter-settings/get-chat-starter-settings-for-a-registered-agent.md): Retrieves welcome message and starter prompts of a specific agent by its id. - [Create Or Update Chat Starter Settings For A Registered Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-chat-starter-settings/create-or-update-chat-starter-settings-for-a-registered-agent.md): Create or update chat starter settings for a registered agent. - [Delete Chat Starter Settings](https://developer.watson-orchestrate.ibm.com/apis/agent-chat-starter-settings/delete-chat-starter-settings.md) - [Create Or Update Icon For Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-chat-starter-settings/create-or-update-icon-for-agent.md): Upload the icon for a registerd agent. ###### API Reference - [Alive](https://developer.watson-orchestrate.ibm.com/apis/alive.md): Get liveness status of the server. We are always assuming alive because of reconnection strategies - [Ready](https://developer.watson-orchestrate.ibm.com/apis/ready.md): Get server readiness to accept traffic ###### channel integration - [List App](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/list-app.md) - [Register App](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/register-app.md) - [Delete App](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/delete-app.md) - [List Slack App Instance](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/list-slack-app-instance.md) - [Register Slack App Instance](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/register-slack-app-instance.md) - [Get Slack App Instance By Id](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/get-slack-app-instance-by-id.md) - [Delete Slack App Instance By Id](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/delete-slack-app-instance-by-id.md) - [Call Slack App Instance](https://developer.watson-orchestrate.ibm.com/apis/channel-integration/call-slack-app-instance.md) ###### Toolkits - [Fetch Toolkits](https://developer.watson-orchestrate.ibm.com/apis/toolkits/fetch-toolkits.md) - [Create A Toolkit](https://developer.watson-orchestrate.ibm.com/apis/toolkits/create-a-toolkit.md) - [Get Toolkit By Id](https://developer.watson-orchestrate.ibm.com/apis/toolkits/get-toolkit-by-id.md) - [Delete A Toolkit By Id](https://developer.watson-orchestrate.ibm.com/apis/toolkits/delete-a-toolkit-by-id.md) - [Patch A Toolkit](https://developer.watson-orchestrate.ibm.com/apis/toolkits/patch-a-toolkit.md) - [List Tools From Mcp Server Without Importing](https://developer.watson-orchestrate.ibm.com/apis/toolkits/list-tools-from-mcp-server-without-importing.md) - [Upload Toolkits Supporting Artifact](https://developer.watson-orchestrate.ibm.com/apis/toolkits/upload-toolkits-supporting-artifact.md) - [Download Toolkits Supporting Artifact](https://developer.watson-orchestrate.ibm.com/apis/toolkits/download-toolkits-supporting-artifact.md) ###### Models - [Fetch Models](https://developer.watson-orchestrate.ibm.com/apis/models/fetch-models.md) - [Create Model](https://developer.watson-orchestrate.ibm.com/apis/models/create-model.md) - [List Models](https://developer.watson-orchestrate.ibm.com/apis/models/list-models.md) - [List Embeddings Models](https://developer.watson-orchestrate.ibm.com/apis/models/list-embeddings-models.md) - [Update Model](https://developer.watson-orchestrate.ibm.com/apis/models/update-model.md) - [Delete Model By Id](https://developer.watson-orchestrate.ibm.com/apis/models/delete-model-by-id.md) ###### Model-Policy - [Fetch Models Policy](https://developer.watson-orchestrate.ibm.com/apis/model-policy/fetch-models-policy.md) - [Create Model Policy](https://developer.watson-orchestrate.ibm.com/apis/model-policy/create-model-policy.md) - [Update Model](https://developer.watson-orchestrate.ibm.com/apis/model-policy/update-model.md) - [Delete Model Policy By Id](https://developer.watson-orchestrate.ibm.com/apis/model-policy/delete-model-policy-by-id.md) ###### Voice Configurations - [List Voice Configurations](https://developer.watson-orchestrate.ibm.com/apis/voice-configurations/list-voice-configurations.md) - [Create Voice Configuration](https://developer.watson-orchestrate.ibm.com/apis/voice-configurations/create-voice-configuration.md) - [Get Voice Configuration](https://developer.watson-orchestrate.ibm.com/apis/voice-configurations/get-voice-configuration.md) - [Delete Voice Configuration](https://developer.watson-orchestrate.ibm.com/apis/voice-configurations/delete-voice-configuration.md) - [Update Voice Configuration](https://developer.watson-orchestrate.ibm.com/apis/voice-configurations/update-voice-configuration.md) ###### Credentials - [Get Datastore Credentials For A Tenant](https://developer.watson-orchestrate.ibm.com/apis/credentials/get-datastore-credentials-for-a-tenant.md) ###### General Channel - [Get All Channels Environment](https://developer.watson-orchestrate.ibm.com/apis/general-channel/get-all-channels-environment.md) ###### Genesys Bot Connector Channel - [List Genesys Bot Connector Channels](https://developer.watson-orchestrate.ibm.com/apis/genesys-bot-connector-channel/list-genesys-bot-connector-channels.md) - [Create Genesys Bot Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesys-bot-connector-channel/create-genesys-bot-connector-channel.md) - [Get Genesys Bot Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesys-bot-connector-channel/get-genesys-bot-connector-channel.md) - [Delete Genesys Bot Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesys-bot-connector-channel/delete-genesys-bot-connector-channel.md) - [Update Genesys Bot Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesys-bot-connector-channel/update-genesys-bot-connector-channel.md) ###### Teams Channel - [List Teams Channels](https://developer.watson-orchestrate.ibm.com/apis/teams-channel/list-teams-channels.md) - [Create Teams Channel](https://developer.watson-orchestrate.ibm.com/apis/teams-channel/create-teams-channel.md) - [Get Teams Channel](https://developer.watson-orchestrate.ibm.com/apis/teams-channel/get-teams-channel.md) - [Delete Teams Channel](https://developer.watson-orchestrate.ibm.com/apis/teams-channel/delete-teams-channel.md) - [Update Teams Channel](https://developer.watson-orchestrate.ibm.com/apis/teams-channel/update-teams-channel.md) ###### Twilio WhatsApp Channel - [List Twilio Whatsapp Channels](https://developer.watson-orchestrate.ibm.com/apis/twilio-whatsapp-channel/list-twilio-whatsapp-channels.md) - [Create Twilio Whatsapp Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-whatsapp-channel/create-twilio-whatsapp-channel.md) - [Get Twilio Whatsapp Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-whatsapp-channel/get-twilio-whatsapp-channel.md) - [Delete Twilio Whatsapp Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-whatsapp-channel/delete-twilio-whatsapp-channel.md) - [Update Twilio Whatsapp Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-whatsapp-channel/update-twilio-whatsapp-channel.md) ###### Twilio SMS Channel - [List Twilio Sms Channels](https://developer.watson-orchestrate.ibm.com/apis/twilio-sms-channel/list-twilio-sms-channels.md) - [Create Twilio Sms Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-sms-channel/create-twilio-sms-channel.md) - [Get Twilio Sms Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-sms-channel/get-twilio-sms-channel.md) - [Delete Twilio Sms Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-sms-channel/delete-twilio-sms-channel.md) - [Update Twilio Sms Channel](https://developer.watson-orchestrate.ibm.com/apis/twilio-sms-channel/update-twilio-sms-channel.md) ###### Facebook Channel - [List Facebook Channels](https://developer.watson-orchestrate.ibm.com/apis/facebook-channel/list-facebook-channels.md) - [Create Facebook Channel](https://developer.watson-orchestrate.ibm.com/apis/facebook-channel/create-facebook-channel.md) - [Get Facebook Channel](https://developer.watson-orchestrate.ibm.com/apis/facebook-channel/get-facebook-channel.md) - [Delete Facebook Channel](https://developer.watson-orchestrate.ibm.com/apis/facebook-channel/delete-facebook-channel.md) - [Update Facebook Channel](https://developer.watson-orchestrate.ibm.com/apis/facebook-channel/update-facebook-channel.md) ###### GenesysAudioConnector Channel - [List Genesys Audio Connector Channels](https://developer.watson-orchestrate.ibm.com/apis/genesysaudioconnector-channel/list-genesys-audio-connector-channels.md) - [Create Genesys Audio Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesysaudioconnector-channel/create-genesys-audio-connector-channel.md) - [Get Genesys Audio Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesysaudioconnector-channel/get-genesys-audio-connector-channel.md) - [Delete Genesys Audio Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesysaudioconnector-channel/delete-genesys-audio-connector-channel.md) - [Update Genesys Audio Connector Channel](https://developer.watson-orchestrate.ibm.com/apis/genesysaudioconnector-channel/update-genesys-audio-connector-channel.md) ###### Slack Channel - [List Slack Channels](https://developer.watson-orchestrate.ibm.com/apis/slack-channel/list-slack-channels.md) - [Create Slack Channel](https://developer.watson-orchestrate.ibm.com/apis/slack-channel/create-slack-channel.md) - [Get Slack Channel](https://developer.watson-orchestrate.ibm.com/apis/slack-channel/get-slack-channel.md) - [Delete Slack Channel](https://developer.watson-orchestrate.ibm.com/apis/slack-channel/delete-slack-channel.md) - [Update Slack Channel](https://developer.watson-orchestrate.ibm.com/apis/slack-channel/update-slack-channel.md) ###### Phone channel global - [List Phone Configs](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/list-phone-configs.md) - [Create Phone Channel](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/create-phone-channel.md) - [Get Phone Config](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/get-phone-config.md) - [Delete Phone Config](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/delete-phone-config.md) - [Update Phone Config](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/update-phone-config.md) - [List Phone Numbers](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/list-phone-numbers.md) - [Add Phone Numbers](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/add-phone-numbers.md) - [Delete Phone Number](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/delete-phone-number.md) - [Patch Phone Number](https://developer.watson-orchestrate.ibm.com/apis/phone-channel-global/patch-phone-number.md) ###### Flows - [Asynchronously run the latest flow version](https://developer.watson-orchestrate.ibm.com/apis/flows/asynchronously-run-the-latest-flow-version.md): Asynchronously run the latest "published" version of a flow with a given flow id. - [Run the latest flow version](https://developer.watson-orchestrate.ibm.com/apis/flows/run-the-latest-flow-version.md): Run the latest "published" version of a flow with a given flow ID. - [List flow instances](https://developer.watson-orchestrate.ibm.com/apis/flows/list-flow-instances.md): List flows runs ###### Agent Evaluation - [Get A Sample Test Case Csv File ](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/get-a-sample-test-case-csv-file.md): Get CSV template for a given agent - [List Test Cases For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/list-test-cases-for-a-given-agent.md): List test cases for a given agent - [Upload Test Cases For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/upload-test-cases-for-a-given-agent.md): Upload test cases for a given agent - [Bulk Delete Test Cases For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/bulk-delete-test-cases-for-a-given-agent.md): Delete test cases for a given agent - [Evaluate Test Cases For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/evaluate-test-cases-for-a-given-agent.md): Evaluate test cases for a given agent - [List Evaluations For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/list-evaluations-for-a-given-agent.md): List evaluations for a given agent - [Bulk Delete Evaluations For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/bulk-delete-evaluations-for-a-given-agent.md): Delete evaluations for a given agent - [Export Evaluations Of A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/export-evaluations-of-a-given-agent.md): Download evaluations for a given agent - [Get Current Running Evaluation For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/get-current-running-evaluation-for-a-given-agent.md): Get evaluation status for a given agent - [Get Evaluation Details](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/get-evaluation-details.md): Get evaluation details for a given agent - [Get Test Cases Of An Evaluation For A Given Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-evaluation/get-test-cases-of-an-evaluation-for-a-given-agent.md): Get evaluation test cases for a given agent ###### Governance monitoring - [Check Monitoring Availability](https://developer.watson-orchestrate.ibm.com/apis/governance-monitoring/check-monitoring-availability.md): Check if monitoring is available - [Get Agent Monitoring Details](https://developer.watson-orchestrate.ibm.com/apis/governance-monitoring/get-agent-monitoring-details.md): Get agent monitoring details - [Setup Agent Monitoring](https://developer.watson-orchestrate.ibm.com/apis/governance-monitoring/setup-agent-monitoring.md): Setup agent monitoring ###### Outbound Policies - [Fetch Outbound Policy For Tenant](https://developer.watson-orchestrate.ibm.com/apis/outbound-policies/fetch-outbound-policy-for-tenant.md) - [Update Policies By Ids](https://developer.watson-orchestrate.ibm.com/apis/outbound-policies/update-policies-by-ids.md) - [Create Policies](https://developer.watson-orchestrate.ibm.com/apis/outbound-policies/create-policies.md) - [Delete Policies By Ids](https://developer.watson-orchestrate.ibm.com/apis/outbound-policies/delete-policies-by-ids.md) - [Api To Check The Url/Set Of Url Is Allowed Or Not](https://developer.watson-orchestrate.ibm.com/apis/outbound-policies/api-to-check-the-urlset-of-url-is-allowed-or-not.md) ###### Agent embedded chat config - [Get Embedded Chat Config For A Registered Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-embedded-chat-config/get-embedded-chat-config-for-a-registered-agent.md): Retrieves embedded chat config for a specific agent by its id. - [Create Or Update Embedded Chat Config For A Registered Agent](https://developer.watson-orchestrate.ibm.com/apis/agent-embedded-chat-config/create-or-update-embedded-chat-config-for-a-registered-agent.md): Create or update embedded chat config for a registered agent. #### Bob / VS Code ADK extension - [Overview](https://developer.watson-orchestrate.ibm.com/adk_extension/overview.md) - [Installing the Orchestrate ADK extension](https://developer.watson-orchestrate.ibm.com/adk_extension/installing_adk_extension.md) - [Using the Orchestrate ADK extension](https://developer.watson-orchestrate.ibm.com/adk_extension/using_adk_extension.md) - [Using Orchestrate ADK Extension command palette](https://developer.watson-orchestrate.ibm.com/adk_extension/adk_extension_command_palette.md) - [Environment switcher](https://developer.watson-orchestrate.ibm.com/adk_extension/environment_switcher.md) - [Web chat embed](https://developer.watson-orchestrate.ibm.com/adk_extension/webchat_embed.md) - [Tutorial: Automating IT Operations with Bob and watsonx Orchestrate](https://developer.watson-orchestrate.ibm.com/adk_extension/tutorial_automate_operations.md) #### ADK MCP Server - [Installing the watsonx Orchestrate ADK MCP Server](https://developer.watson-orchestrate.ibm.com/mcp_server/wxOmcp_installation.md) - [Configuring the watsonx Orchestrate ADK MCP Server](https://developer.watson-orchestrate.ibm.com/mcp_server/wxOmcp_configuration.md) - [Orchestrate Documentation MCP Server](https://developer.watson-orchestrate.ibm.com/mcp_server/wxOmcp_docs_server.md) - [Connecting MCP Clients to the watsonx Orchestrate ADK MCP Server](https://developer.watson-orchestrate.ibm.com/mcp_server/wxOmcp_integration.md) #### Agentic SDK Guide - [Introduction](https://developer.watson-orchestrate.ibm.com/sdk/sdk_intro.md) - [Chat models](https://developer.watson-orchestrate.ibm.com/sdk/chat_wxo.md) - [Embeddings](https://developer.watson-orchestrate.ibm.com/sdk/wxo_embeddings.md) - [Memory](https://developer.watson-orchestrate.ibm.com/sdk/memory.md) - [Context](https://developer.watson-orchestrate.ibm.com/sdk/context.md) ##### Client - [Client](https://developer.watson-orchestrate.ibm.com/sdk/client.md) - [Runs-on](https://developer.watson-orchestrate.ibm.com/sdk/runs_on.md) - [Runs-elsewhere](https://developer.watson-orchestrate.ibm.com/sdk/runs_else.md) - [Local](https://developer.watson-orchestrate.ibm.com/sdk/local.md) ### Legal notices - [Notices](https://developer.watson-orchestrate.ibm.com/notices/notices.md) - [Security and Privacy by Design (SPbD)](https://developer.watson-orchestrate.ibm.com/notices/spbd.md) #### ADK license reference - [International Program License Agreement](https://developer.watson-orchestrate.ibm.com/license/la_en.md) - [LICENSE INFORMATION](https://developer.watson-orchestrate.ibm.com/license/li_en.md) - [NOTICES AND INFORMATION](https://developer.watson-orchestrate.ibm.com/license/notices.md) - [TERMS AND CONDITIONS FOR SEPARATELY LICENSED CODE](https://developer.watson-orchestrate.ibm.com/license/non_ibm_license.md)