Connecting your first app

Connecting an app to Caddey is the first step to creating tools and workflows that your AI assistant can use. There are two ways to add apps to Caddey:

1. Connect from the marketplace: Choose from pre-configured apps in the Caddey marketplace
2. Upload an API Specification: Add your own custom app by uploading its OpenAPI specification

This guide walks you through both methods and explains how to authenticate your apps.

Method 1: Connect an app from the marketplace

Step 1: Navigate to the marketplace

1. Log in to your Caddey account
2. Open the Caddey dashboard
3. Select the Apps tab from the sidebar menu
4. Click the Marketplace button to view the marketplace

Step 2: Browse and select an app

1. Browse through the available apps in the marketplace
2. When you find an app you want to use, click the Connect button on the app card

Step 3: Configure authentication (if required)

When connecting a marketplace app, you'll see one of these scenarios:

• No authentication required: If the app doesn't require authentication, you'll see a message indicating this, and you can connect directly
• Authentication required: If the app requires authentication, you'll need to provide credentials:
  • If the app provides published keys, you can select an existing key
  • If the app does not provide published keys, you'll need to create a new key

For creating a new key:

1. Select the appropriate Authentication scheme from the dropdown

2. Enter the required credentials based on the authentication type:

   • API Key: Enter your API key
   • HTTP Basic: Enter username and password
   • HTTP Bearer: Enter your bearer token
   • OAuth: Enter client ID, client secret, and other required OAuth parameters
   • OpenID Connect: Enter client ID, client secret, and issuer URL

3. Click Connect to complete the process

Method 2: Add a custom app with an API specification

Step 1: Navigate to the Apps section

1. Log in to your Caddey account
2. Open the Caddey dashboard
3. Select the Apps tab from the sidebar menu

Step 2: Create a new app

1. Click the Add App button in the Apps section
2. Provide basic app information:
   • Enter a name for your app
   • Add a description to help identify its purpose
   • Optionally, add an avatar image
3. Click Create to save the app

Step 3: Upload the OpenAPI specification

1. In the app editor view, you'll see the OpenAPI editor
2. You can either:
   • Paste your OpenAPI specification JSON/YAML into the editor
   • Use the editor to create a specification from scratch
3. The editor will validate your specification in real-time
4. Make sure your specification includes:
   • Proper endpoint definitions
   • Operation descriptions
   • Authentication schemes (if your app requires authentication)

Step 4: Save your specification

1. Once you've added and validated your specification, click Save to update the app
2. Caddey will process the specification and extract authentication schemes and operations