Hermes Agent / Agent Plan reference

Hermes Agent integration reference

Configure Hermes with the official model block: a custom provider, the /v3 route, and the codex_responses API mode.

1 · Quick start

Connect Hermes Agent in three moves

Start with the matching configuration file, keep the key in the named secret location, and use one exact Model ID throughout the setup.

01

Install Hermes Agent

Use the official installer script on macOS or Linux, then reload your shell. Native Windows is not supported; install WSL2 first and run the same script inside it.

02

Configure the model block

Edit ~/.hermes/config.yaml directly, or run the equivalent official commands: hermes config set model.provider custom, model.base_url, model.api_key, model.default, and model.api_mode codex_responses.

03

Choose the default model

Set model.default to one exact Model ID from the Agent Plan page. Keep the value unchanged while diagnosing connectivity.

The key is delivered to your Dashboard after payment. Replace the placeholder in the example, then keep the real value in your environment or local secret file.

2 · Configuration

Copy the provider blueprint

This is a safe starting point for the current Agent Plan route. Keep existing tool settings that are unrelated to the provider and replace only the placeholder key and Model ID values.

# ~/.hermes/config.yaml
model:
  default: glm-5.2
  provider: custom
  base_url: https://ark.cn-beijing.volces.com/api/plan/v3
  api_key: YOUR_AGENT_PLAN_KEY
  api_mode: codex_responses

The default Model ID shown here is the stocked plan's current default. If you choose another supported model, replace every model field required by Hermes Agent, not just the visible label.

Install / launch

curl -fsSL https://raw.githubusercontent.com/NousResearch/hermes-agent/main/scripts/install.sh | bash

3 · Verify the route

Confirm the connection before a full project

Restart hermes after changing config.yaml.

Run a short prompt and confirm the response before connecting tools or long-running tasks.

If your installed Hermes version uses different field names, keep the same five model.* values: default, provider, base_url, api_key, and api_mode.

Troubleshooting

Common configuration pitfalls

config.yaml holds the raw key. Keep the file private, never commit it, and avoid sharing screenshots of it.

Do not omit api_mode: codex_responses — without it Hermes will not use the Responses API route this endpoint expects.

The custom endpoint is OpenAI-compatible; the Claude Code base URL is not interchangeable with it.