Skip to content
BENIBIX Learn

Hermes API Server

AI🪽 Hermes AgentHermes Gateway

Also known as Hermes OpenAI-compatible API, API_SERVER_ENABLED, Hermes port 8642

Lets other chat apps use Hermes. They talk to it the way they talk to OpenAI.

Think of it like

It is like a plug that fits every wall socket. Any lamp can use it.

Example

Emma already uses Open WebUI. She points it at http://localhost:8642/v1, and her old chat screen now talks to Hermes with all its tools.

Why it matters

You keep the chat screen you like and get an agent behind it, not just a model.

Definition

The Hermes API server lets other apps talk to Hermes as if it were a model. It speaks the same web format as OpenAI's chat API. You turn it on in ~/.hermes/.env and start the gateway. It then listens on port 8642 on your own machine. Chat apps such as Open WebUI connect to it, and every reply can use Hermes tools, memory and skills.

Example code

bash
API_SERVER_ENABLED=true
API_SERVER_KEY=change-me-local-dev
hermes gateway
Two lines in ~/.hermes/.env, then start the gateway. It listens on port 8642.
The API server is the way in for other apps. It listens on port 8642.

Common mistake

Opening it to the internet with the sample key. Set a long, secret key before anyone else can reach it.

Key takeaways

  1. 1
    OpenAI format. Any matching app can connect.
  2. 2
    Full agent behind it. Tools, memory and skills.
  3. 3
    Runs with the gateway. Start it with hermes gateway.