Quickstart
Get your agent integrated with IBM watsonx Orchestrate
Follow the steps below to get started with the Agent Connect Framework which will enable your agent to integrate with watsonx Orchestrate.
Enable your agent for collaboration
To make your agent compatible with watsonx Orchestrate, you need to implement the Agent Connect API endpoints. The primary endpoint is the chat completion endpoint, which follows the OpenAI chat completions format.
Step-by-step example
Step-by-step example
Set up your server
First, create a server that will host your agent’s API endpoints. You can use any web framework in your preferred language. Here are a few examples using Express.js, Flask and Go’s standard library:
Implement the chat completion endpoint
Add the chat completion endpoint to your server:
Implement the agent discovery endpoint
Add the agent discovery endpoint to allow your agent to be discovered:
Implement message processing logic
Create functions to process messages and generate responses:
Deploy your agent
Deploy your agent to a publicly accessible URL. You can use platforms like:
- IBM Cloud Code Engine
- AWS Lambda
- Google Cloud Run
- Your own infrastructure
Ensure your agent is accessible via HTTPS for security.
Using an open source agent framework?
Check out our examples for ideas on how to use popular open source frameworks with Agent Connect.
Log in to watsonx Orchestrate
To connect your agent with watsonx Orchestrate, you need to log in to an IBM watsonx Orchestrate account.
- If you already have an account set up, log in to watsonx Orchestrate .
- If you don’t have an account, you can sign up for a watsonx Orchestrate free trial:
- Visit the watsonx Orchestrate free trial page and follow the instructions to sign up.
Register your agent with watsonx Orchestrate
Now that you deployed your agent and you have access to watsonx Orchestrate, you can register your agent.
Registering your agent with the Agent Development Kit (ADK)
Registering your agent with the Agent Development Kit (ADK)
Install the ADK
Navigate to Installing the ADK to learn how to install the ADK.
Register an external agent
For more information, see External Agents .
Deploy your agent
For more information, see Deploying Agents .
Registering your agent to another agent in Agent Builder
Registering your agent to another agent in Agent Builder
Open the Agent Builder
Navigate to Build > Agent Builder.
Select an agent
Select an agent from the catalog.
Add your agent
From the Toolset, click Add agent.
Import agent
Click Import to import your external agent.
Add external agent
On the Import agent screen, select External agent and click Next.
Add agent information
Provide the following details:
- Authentication: Specify the type of authentication and the credentials for your agent.
- Service instance URL: The URL endpoint of your agent’s chat API (for example,
https://your-agent.example.com/chat
). - Display Name: A user friendly name for your agent.
- Description: An intuitive description of what your agent does and how it should be used.
Click Import Agent to finish the process.
Test your agent
Use the chat preview to test your agent.
Next Steps
Now that you’ve successfully integrated your agent with watsonx Orchestrate, you can explore more advanced features: