Connecting your AI agent
Learn how to connect your AI agent to Caddey using OAuth for secure access to tools and toolboxes.
Connecting your AI agent to Caddey lets it discover, search, and execute tools from your connected toolboxes securely. This guide explains how to create an OAuth client that represents your AI agent and configure its access to toolboxes.
Step 1: Navigate to the Clients section
- Log in to your Caddey account.
- Open the Caddey dashboard.
- Select the Clients tab from the sidebar menu.
Step 2: Create a new OAuth client
-
Click "Add client"
In the Clients section, click the Add client button to begin. -
Provide client details
- Enter a name for your AI agent (e.g., "My ChatGPT Assistant").
- Optionally, add a brief description to explain its purpose.
- Choose Public as the client type (AI agents don't store secrets securely).
-
Save the client
Once you've entered the details, save the client. You'll receive a Client ID that represents your AI agent.
Step 3: Note your OAuth configuration
- Client ID: This identifies your AI agent to Caddey's OAuth system.
- Authorization URL:
https://auth.caddey.ai/realms/caddey/protocol/openid-connect/auth
- Token URL:
https://auth.caddey.ai/realms/caddey/protocol/openid-connect/token
- Important: Keep your Client ID secure, as it will be needed to integrate your AI agent.
Step 4: Connect toolboxes to the client
- Within the client settings, click Add Toolbox.
- Select from the list of available toolboxes that you want your AI agent to access.
- Save your selections to grant the client access to the chosen toolboxes.
Step 5: Integrate your AI agent
- Follow the specific guides for your AI agent platform:
These guides provide detailed instructions on setting up OAuth authentication for your AI agent.
Tips for managing OAuth clients
- Keep your Client ID secure: Treat your Client ID like a password and regenerate it if compromised.
- Organize clients logically: Name clients clearly to make management easier (e.g., "Production ChatGPT", "Dev Assistant").
- Update toolbox connections as needed: You can add or remove toolboxes from a client at any time based on your workflow needs.
Need assistance? Visit the Support Section.