Skip to main content

WorkBuddy Integration Guide for Agnes Models

1. Overview

This guide explains how to configure Agnes custom models in WorkBuddy. After configuration, WorkBuddy can directly call Agnes text models for chat, coding, and Agent tasks. You can also use Agnes image and video models through WorkBuddy Skills.

2. Prerequisites

Before starting, make sure you have:
  • WorkBuddy installed.
  • An Agnes AI API Key.
  • A network environment that can access the Agnes AI API Gateway.
  • The model name you want to use.
This guide is based on WorkBuddy v4.24.5.

3. Get an Agnes API Key

Visit the Agnes AI Platform: https://platform.agnes-ai.com/ After logging in, go to the API Key page, create an API key, and copy it.

4. Open Custom Model Settings

Open WorkBuddy. On the page, click:
Auto
Then select: Configure Custom Model

5. Select a Custom Provider

Scroll to the bottom of the provider list and select:
Other
or:
Custom
This option indicates that you want to use a custom OpenAI-compatible API service.

6. Add the Agnes Text Model

Click Add Model and fill in the following parameters: Provider: Custom API Base URL: https://apihub.agnes-ai.com/v1 API Key: YOUR_API_KEY Model Name: agnes-2.0-flash Replace YOUR_API_KEY with your actual API key.

7. Save the Configuration

After confirming that all information is correct, click Save. Once saved successfully, you should see the following model in the model list: agnes-2.0-flash

8. Select the Model

In the WorkBuddy chat interface, select: agnes-2.0-flash After the model is selected successfully, the text model configuration is complete.

9. Verify the Text Model

Start a normal chat, for example:
Hello, please introduce yourself.
If the configuration is correct, WorkBuddy should return a response from the Agnes model.

10. Configure Image and Video Models

Agnes image and video models can be used in WorkBuddy by creating Skills. You can enter the following prompt in WorkBuddy and let it automatically create a Skill:
I want to use the Agnes Image 2.0 model to generate images and videos. Please visit its API platform at https://agnes-ai.com/doc/overview and package it as a Skill.
WorkBuddy will generate image and video-related Skills based on the Agnes API documentation.

11. Use the Image Skill

After the Skill is created, open the Skill list and select the image generation Skill. Example Skill name: agnes-image-gen Then enter an image generation prompt. Example:
Generate a cyberpunk city night scene with neon lighting, cinematic style, and high detail.
If the configuration is correct, WorkBuddy will call the Agnes image model and return the generated result.

12. Use the Video Skill

Select the video generation Skill. Example Skill name: agnes-video-gen Then enter a video generation prompt. Example:
Generate a 5-second video of an Asian female model wearing a black dress in a white photography studio. The camera slowly moves from a full-body shot to a half-body close-up while she turns naturally.
If the configuration is correct, WorkBuddy will submit the video generation task and return the task status or video URL.

13. Troubleshooting

1. The text model does not return a response

Check whether the API Base URL is correct: https://apihub.agnes-ai.com/v1 Also confirm that your API Key is valid.

2. agnes-2.0-flash does not appear in the model list

Make sure the model name is entered correctly: agnes-2.0-flash Model IDs are usually case-sensitive. It is recommended to copy the model name directly from the platform.

3. Image or video Skill creation fails

Make sure WorkBuddy can access the Agnes documentation URL: https://agnes-ai.com/doc/overview Also confirm that the current model has the ability to read documents and create Skills.

4. The video task takes a long time to complete

Video generation usually takes some time. Please wait for the task to complete, then check the returned video URL or task status.

5. Authentication fails

Check whether the API Key is correct and whether your account balance or credits are sufficient.