ChatGPT with Caddey

This guide provides detailed instructions on creating a custom GPT in ChatGPT that integrates with Caddey, enabling your ChatGPT to query and execute app tools securely. This setup requires a ChatGPT Plus/Pro subscription and an active Caddey OAuth client.

Prerequisites

• ChatGPT Plus/Pro Subscription: Access to custom GPT features.
• Caddey account: A Caddey account to create an OAuth client and connect tools.

Step 1: Create a Caddey OAuth Client

Before integrating with ChatGPT, ensure you have an active OAuth client in Caddey:

1. Log in to your Caddey account.
2. Navigate to the Clients section in the dashboard.
3. Click Add client to create a new OAuth client.
4. Enter the required details (e.g., client name "ChatGPT Assistant" and description), choose Confidential as client type.
5. Leave the Redirect URIs field empty for now - you'll get the exact callback URL from ChatGPT in the next steps.
6. Save the client.
7. Note the Client ID and Client Secret: Once the client is created, copy both the Client ID and Client Secret—both will be needed for OAuth authentication in ChatGPT.

Step 2: Access the Custom GPT Builder in ChatGPT

1. Log in to your ChatGPT account.
2. Navigate to Explore GPT's.
3. Click the Create button to create a new GPT.

Step 3: Configure GPT Details

1. Title:
   Enter a name for your custom GPT integration (e.g., Caddey).

2. Description:
   Provide a brief description such as: Bring your tools to ChatGPT

3. Customize
   Provide instructions, conversation starters, and capabilities according to your needs.

Step 4: Create action

1. Navigate to Create new action in the custom GPT builder.
2. For authentication, choose OAuth and configure:
   • Authorization URL: https://auth.caddey.ai/realms/caddey/protocol/openid-connect/auth
   • Token URL: https://auth.caddey.ai/realms/caddey/protocol/openid-connect/token
   • Client ID: Your Client ID from Step 1
   • Client Secret: Your Client Secret from Step 1
   • Scope: openid profile email
3. Copy the Callback URL: After configuring OAuth, ChatGPT will display a callback URL (it will look like https://chat.openai.com/aip/g-{unique-id}/oauth/callback). Copy this URL.
4. Update your Caddey OAuth Client: Go back to your Caddey dashboard, edit the OAuth client you created in Step 1, and add the callback URL you just copied to the Redirect URIs field. Save the client.
5. For the schema, choose Import from URL. Enter the URL: https://api.caddey.ai/v3/api-docs/tools
6. Confirm the import. ChatGPT will load and recognize the following endpoints:
   • GET /tools/query – to search and paginate through available tools.
   • POST /tools/{toolId}/execute – to execute a specific tool with JSON input.

Step 5: Test Your Integration

1. Query Tools: Use the preview in the custom GPT builder to ask what tools are available. ChatGPT should respond with some of the tools in the toolboxes you assigned to your OAuth client.
2. Execute a Tool: Now ask ChatGPT to use one of the available tools. If required for the tool, provide ChatGPT with relevant input.

Finalize and Deploy

Once all tests are successful, save your custom GPT integration. You can now talk to the Caddey GPT to use your tools.