HermesAgents Integration Guide

Configure WOX models in HermesAgents

Configuring WOX Models in HermesAgents

1. Overview

This guide explains how to configure a custom model provider in HermesAgents. Once configured, HermesAgents will send model requests to the specified API endpoint and use the selected model to complete agent tasks.

2. Prerequisites

3. Open a Terminal

Open a terminal or command-line tool on your device.

On macOS or Linux, you can use Terminal.

On Windows, you can use Command Prompt, PowerShell, or the terminal in your development environment.

4. Configuration Command Format

HermesAgents configuration commands generally use the following format:

hermes config set <configuration_key> <value>

Note that set must come before the configuration key.

5. Configure the Model Provider

Run the following command:

hermes config set model.provider custom

This command tells HermesAgents to use a custom model provider instead of its default built-in provider.

6. Configure the API Base URL

Run the following command:

hermes config set model.base_url https://api.wox.lol/v1

This command sets the WOX API gateway as the endpoint for HermesAgents model requests.

The API Base URL usually only needs to end with /v1. You do not need to append /chat/completions manually.

Recommended format:

Generally not recommended:

Use the full API path only if HermesAgents explicitly asks for the complete endpoint URL.

7. Configure the API Key

Run the following command:

hermes config set model.api_key YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key.

Example:

hermes config set model.api_key sk-xxxxxxxxxxxxxxxx

In most cases, you do not need to add the Bearer prefix manually unless HermesAgents explicitly asks for the complete Authorization header.

If you prefer to configure the API key using an environment-variable-style setting, you can also use:

hermes config set OPENAI_API_KEY YOUR_API_KEY

For a custom model provider, however, the recommended setting is:

hermes config set model.api_key YOUR_API_KEY

8. Configure the Model Name

Run the following command:

hermes config set model.default YOUR_MODEL_ID

Use the complete model ID provided by the platform.

Model IDs are usually case-sensitive. Copying the model name directly from the platform is recommended.

9. Complete Configuration Example

10. Complete Command Example

hermes config set model.provider custom
hermes config set model.base_url https://api.wox.lol/v1
hermes config set model.api_key YOUR_API_KEY
hermes config set model.default YOUR_MODEL_ID

11. Verify the Configuration

After completing the configuration, run a HermesAgents task or start a test session.

If everything is configured correctly, HermesAgents should call the specified API endpoint and return model responses successfully.

12. Troubleshooting

1. Authentication Fails

Check that your API key is valid.

You can reset the API key by running:

hermes config set model.api_key YOUR_API_KEY

Also make sure your account has sufficient balance or credits.

2. API Requests Fail

Check that the API Base URL is correct:

You generally do not need to append /chat/completions manually.

Correct example:

Generally not recommended:

Use the full API path only if HermesAgents explicitly asks for the complete endpoint URL.

3. Model Provider Is Not Recognized

Make sure the model provider is set to:

hermes config set model.provider custom

4. Model Not Found

Check that the model name is correct.

Try running the following command again:

hermes config set model.default YOUR_MODEL_ID

Model IDs are usually case-sensitive. Copying the model name directly from the platform is recommended.

5. Network Error

Make sure your device can access the API endpoint.

If the request fails, check your firewall, proxy, or VPN settings.

13. Notes

HermesAgents uses a configuration style similar to OpenAI-compatible APIs.

For custom model providers, the API Base URL usually ends with /v1.

Recommended format:

Configure the API key separately through model.api_key.

The model provider should be set to:

custom

This ensures that HermesAgents uses the custom API endpoint instead of its default model provider.