Explore documentation sources

Edit online

IBM watsonx Orchestrate offers a rich ecosystem of documentation tailored to different user roles and use cases, from users in the user interface (UI) to developers who build agents and integrations. Choose the source that best fits your task. Each resource includes who it’s for, when to use it, and where it applies.

How to use the documentation sources

Start with the UI documentation if you're exploring watsonx Orchestrate features or need help on how the interface works.
Switch to developer documentation when you begin building agents, integrating systems, or need capabilities beyond what the UI provides.
Use deployment documentation when you are installing or configuring watsonx Orchestrate in an on‑premises environment.
Explore partner documentation when you want to collaborate with IBM or integrate your AI product as part of the Agent Connect Partner Program.

Documentation sources overview


Category	Documentation source	Audience	When to use
Primary documentation sources	IBM watsonx Orchestrate documentation (You are here)	All users	Use the core UI documentation when you need guidance on watsonx Orchestrate features, workflows, or interface behavior.
Developer and builder resources	IBM watsonx Orchestrate Agent Development Kit (ADK) documentation	Developers and technical builders	It is a pro‑code documentation for building and customizing agents, tools, and integrations. Use when you are developing agents or tools and need advanced configuration options.
	IBM watsonx Orchestrate API documentation	Developers and technical builders	Use this REST API reference when integrating external systems with watsonx Orchestrate or automating tasks programmatically across AWS, IBM Cloud, or on‑premises deployments.
Assistant Builder and embedded chat APIs for assistants	IBM watsonx Assistant API documentation	Developers using Assistant Builder	Use this when building assistants or integrating shared assistant capabilities between watsonx Assistant and watsonx Orchestrate.
	Web chat API documentation for watsonx Assistant	Developers embedding assistants	Use this API reference for embedding the assistant web chat interface. Use when you are embedding assistants built in Assistant Builder into web apps or portals.
On-premises deployment	IBM watsonx Orchestrate on Software Hub documentation	System administrators	Use this installation and administration guide when deploying watsonx Orchestrate in a private, on-premises environment using IBM Software Hub.
Partner resources	IBM Agent Connect documentation	IBM partners and AI solution providers	Refer to this when integrating your AI product with watsonx Orchestrate through the Agent Connect Partner Program.

Next steps

New to watsonx Orchestrate? Read Getting started with watsonx Orchestrate.
Explore the watsonx Orchestrate catalog: Visit Discovering the catalog.
Start building: See Building agents.