Connecting your first app

Connecting an app to Caddey is the first step to creating tools and workflows that your AI assistant can use. This guide explains how to define an app, upload its specification, generate tools for integration, and authenticate the app.

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: Define a new app

1. Click "Add App"
   In the Apps section, click the Add App button to begin the process.

2. Provide app information

   • Enter a name for the app.
   • Optionally, add a brief description to help identify its purpose.

3. Save the app
   Once you’ve entered the basic details, save the app to proceed to the next step.

Step 3: Add the app's specification

1. Upload OpenAPI spec

   • After defining the app, upload its OpenAPI specification file.
   • This specification allows Caddey to identify the app’s capabilities and endpoints.

2. Review the specification

   • Verify that the uploaded specification is accurate and complete.
   • Resolve any errors or missing details before proceeding.

Step 4: Generate tools

1. Once the app specification is uploaded and validated, Caddey will automatically extract its operations and generate tools.
2. Review the generated tools to ensure they align with your requirements.
3. Customize tool names or descriptions as needed for clarity.

Step 5: Authenticate your app

Note: This step is only necessary if your app requires authentication.

1. Navigate to the Keys tab in your Caddey dashboard.
2. Add a new key by clicking the Add Key button.
3. Select the app you just added from the list.
4. Pick the authentication scheme (e.g., API key or OAuth) as defined in the app's specification.
5. Enter your credentials: Provide the necessary key or token for authentication.
6. Save your key to complete the process.

This final step ensures that your app is properly authenticated, allowing Caddey to securely execute tool operations on your behalf.