WorkBuddy Integration Guide
Integrate WOX models with WorkBuddy
WorkBuddy Integration Guide
Integrate WOX models with WorkBuddy
Integrating WOX Models with WorkBuddy
1. Overview
This guide explains how to configure a custom WOX model in WorkBuddy. Once configured, WorkBuddy can call WOX text models directly for chat, coding, and agent tasks. You can also use WOX image and video models through WorkBuddy Skills.
2. Prerequisites
Before you begin, make sure you have:
- WorkBuddy installed.
- A WOX API Key.
- A network connection that can reach the WOX API gateway.
- The name of the model you want to use.
This guide is based on WorkBuddy v4.24.5.
3. Get a WOX API Key
Open the WOX platform:
Sign in, open the API Key page, create an API key, and copy it.
4. Open the Custom Model Settings
Open WorkBuddy.
On the page, click:
AutoThen select:
Configure Custom Model
5. Select a Custom Provider
Scroll to the bottom of the provider list and select:
OtherOr:
CustomThis option lets you use a custom OpenAI-compatible API service.
6. Add a WOX Text Model
Click Add Model and enter the following values:
Provider:Custom
API Base URL: https://api.wox.lol/v1
API Key: YOUR_API_KEY
Model name: YOUR_MODEL_ID
Replace YOUR_API_KEY with your actual API key.
7. Save the Configuration
After confirming that all the information is correct, click Save.
Once saved, the following model should appear in the model list:
YOUR_MODEL_ID
8. Select the Model
In the WorkBuddy chat interface, select:
YOUR_MODEL_ID
The text model is ready once it has been selected.
9. Test the Text Model
Start a regular chat, for example:
Hello, please introduce yourself.If the configuration is correct, WorkBuddy should return a response from the WOX model.
10. Configure Image and Video Models
You can use WOX image and video models in WorkBuddy by creating Skills.
Enter the following prompt in WorkBuddy to have it create a Skill automatically:
I want to use the image or video models currently available through WOX. Read the API documentation at https://g.wox.lol/docs and configure the request workflow as a Skill.WorkBuddy will use the WOX API documentation to generate Skills for image and video models.
11. Use an Image Skill
After creating the Skill, open the Skills list and select the image generation Skill.
Example Skill name:
wox-image-gen
Then enter an image generation prompt.
Example:
Generate a highly detailed, cinematic cyberpunk city at night with neon lighting.If the configuration is correct, WorkBuddy will call a WOX image model and return the generated result.
12. Use a Video Skill
Select the video generation Skill.
Example Skill name:
wox-video-gen
Then enter a video generation prompt.
Example:
Generate a five-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 medium close-up as she turns naturally.If the configuration is correct, WorkBuddy will submit a video generation task and return its status or video URL.
13. Troubleshooting
1. The text model does not respond
Check that the API Base URL is correct:
https://api.wox.lol/v1
Also confirm that your API Key is valid.
2. YOUR_MODEL_ID does not appear in the model list
Make sure the model name is correct:
YOUR_MODEL_ID
Model IDs are usually case-sensitive. Copy the model name directly from the platform.
3. WorkBuddy cannot create the image or video Skill
Make sure WorkBuddy can access the WOX documentation URL:
https://g.wox.lol/docs
Also confirm that the current model can read documentation and create Skills.
4. The video task takes a long time
Video generation can take some time.
Wait for the task to finish, then check the returned video URL or task status.
5. Authentication fails
Check that the API Key is correct and that your account has sufficient balance or credits.