API reference

Get the details of the methods that you can use to achieve your use cases.

• AI Agent

  Use the operations of this method to chat with the AI agent with the possibility of streaming the responses in real-time, or to get the details of a specific run and get the list of events for a specific run of the AI agent.

• AI Assistant

  Use the operations of this method to register, get, list, update, or delete an AI assistant from the chat.

• Artifact Management

  Use the operations of this method to create, update, get, and delete skills added directly to the AI chat.

• Assistants Runs

  Use the operations of this method to run a specific AI assistant, get the list of all runs for a specific AI assistant, or get the details of a specific run for an AI assistant.

• Catalog Management

  Use the operations of this method to fetch all the artifact groups and artifacts available in the catalog for the AI chat. For the definition of this API, artifact groups can be applications and skill-flows, and they can hold imported skills, prebuilt skills, skill flows, and workflow skills.

• Default Agent Settings

  Use the operations of this method to get or update the current settings of the AI agent for the tenant associated with the authenticated user.

• External AI agents

  Use the operations of this method to create, update, get, and delete external AI agents from the AI chat. External AI agents are agentic services that are hosted outside of watsonx Orchestrate product. For these agents, the model uses chat completion for multi-turn conversations in the AI chat.

• Journeys

  Use the operations of this method to get the journeys available to the router for a specific tenant.

• JWT token

  Use the operations of this method to get the JWT that authenticates you on watsonx Orchestrate API.

• Skill sets

  Use the operations of this method to get the resources of specific skill sets such as imported skills, decisions, workflows, and generative AI skills. Prebuilt skills from the catalog and skill flows are not supported.

• Skills

  Use the operations of this method to use your resources such as imported skills, decisions, workflows, and generative AI skills. Prebuilt skills from the catalog and skill flows are not supported.

• Message Threads

  Use the operations of this method to create, update, get, and delete messages and message threads.

• Welcome message

  Use the operations of this method to create, update, get, and delete the custom content of the welcome message displayed in the AI chat.