Associating connections to Custom agents - IBM watsonx Orchestrate ADK

Unlike other agents, you associate a connection to a custom agent through the orchestrate agents experimental-connect command. The process for creating a connection stays the same.

BASH

orchestrate agents experimental-connect -n <custom agent name> -c <connection ID>

Show command flags

--name / -n

string

Name of the agent to connect connections to.

--connection-id / -c

string

Connection app_id to connect. Multiple can be specified: --connection-id conn1 --connection-id conn2.

watsonx Orchestrate uses your connection to set custom agent credentials. It injects your credential key at runtime. It follows the format:

{connection_app_id}_{credential_type}

Where:

connection_app_id is the unique ID of your connection app.
credential_type is the value you set with the -k parameter when you configure the connection.

For example, when you run:

BASH

orchestrate connections configure --app-id openai_api --environment draft -t team -k api_key

Your credential key becomes:

openai_api_api_key

For more details on creating and configuring connections, see Creating connections.

Documentation Index