About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Icon Description
Focus sentinelFocus sentinel
Documentation Version Alert
Important Notice
Close
The documentation for product version () you are trying to access is NOT yet available. This page displays the documentation for the current available version (1.0.1).
IBM watsonx Orchestrate API
By IBM watsonx Orchestrate
IBM watsonx Orchestrate provides a set of APIs to boost your experience using the features from the product.
Introduction
Getting Started
Generating the JSON Web Token
Get a list of skill sets
Get a list of skills for a skill set
Get an OpenAPI specification of a skill
Use a skill based on GET method
Use a skill based on POST method
Use a skill based on PUT method
Use a skill based on DELETE method
Use a skill based on PATCH method
Create an artifact of category webhook
List all artifacts
Get an artifact's details
Update an artifact
Delete an artifact from the catalog
List all artifacts available in the catalog
List all available skills under an application
List all AI Assistant instances
Register AI Assistant instances
Get AI Assistant instance
Update AI Assistant instance
Delete AI Assistant instance
List all registered external agents
Register an external agent
Delete a registered external agent
Get a registered external agent by ID
Update a registered external agent
List message threads
Create a message thread
Get the message thread by ID
Update a message thread
Delete a message thread
Create a message
List messages
Update a message
Delete a message
Get a message by ID
Chat with an AI agent
Lists an AI agent runs
Chat with an AI agent as stream
Get an AI agent run
Get an AI agent run events
List all possible journeys
Run assistant
List the runs of an assistant
Get assistant run by ID
Get Orchestrate settings
Update Orchestrate settings
Update the routing description of a skill
Remove a skill from the AI agent chat
Update the properties of a skill
Fetch the list of skills added to the AI agent chat
Add a skill to the AI agent chat
Get the content of the welcome message
Create or update the content of the welcome message
Delete the content of the welcome message
FAQ and support
Related resources
Getting the API endpoint
Authenticating to the API
Known issues and limitations
Loading ...
