Alfred AI

What is Alfred AI?

Alfred  is Treblle’s AI assistant. It helps improve your API workflows by using your API documentation to provide real-time answers.

Monitoring Alfred Usage

Alfred AI provides a comprehensive dashboard where you can track how your team is using the AI assistant. This helps you understand usage patterns, identify popular queries, and optimize your API documentation based on real team interactions.

Accessing the Alfred Dashboard

• Navigate to the Alfred AI section in your Treblle workspace
• Click on the “Analytics” or “Usage” tab to view the dashboard

Review metrics such as:

• Most frequently asked questions
• Team member activity
• Popular API endpoints being queried
• Usage trends over time

This dashboard insight helps you identify knowledge gaps in your documentation and understand which parts of your API your team needs the most help with.

There are several ways to use Alfred:

• Integrating with Treblle SDK.
• Uploading your OpenAPI Specification.
• Embedding Alfred to your Developer Portal.

Integrating with Treblle SDK

Integrating the Treblle SDK will automatically generate API docs and a developer portal with Alfred.

You can find integration guides for various languages and platforms here.

Step 1: Accessing Alfred

Go to the API Docs section of your Treblle workspace.

Look for Alfred in the bottom right corner of the screen.

Step 2: Interact with Alfred

Click on Alfred to open an interface with predefined prompts.

Ask questions or request assistance with your API documentation, such as identifying issues, generating code examples, or improving endpoint documentation.

Example:

Uploading your OpenAPI Specification

If you are not integrating the Treblle SDK, you can upload your OpenAPI Specification  (version 3 or above) directly to the Treblle platform.

Step 1: Access OpenAPI Specification

Go to the API Setting section of your Treblle workspace.

Step 2: Upload OpenAPI Specification

Click on upload to add your OpenAPI Specification.

Embedding Alfred to your Developer Portal

To embed Alfred into your developer portal, follow these steps:

1. Add a one-line script to your HTML:

   <script src="https://assets.treblle.com/alfred@1.0.3.js"></script>

   Place the script before your portal’s </body> tag to ensure smooth page rendering.

2. Replace _YOUR_TREBLLE_SDK_TOKEN_ with your API ID and _YOUR_CUSTOMER_API_KEY_ with your SDK TOKEN.

   <div
     class="getalfred-io"
     data-api="_YOUR_TREBLLE_SDK_TOKEN_"
     data-auth="_YOUR_CUSTOMER_API_KEY_"
   ></div>