API Server
API Server
Start with meaning, then move to detail.
This lesson explains API Server as part of Hermes internals and extension points. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Quick Start, 1. Enable the API server, 2. Start the gateway, then verify failure modes and version compatibility.
Know Python, Git, and basic project structure before changing code.
A clear outcome before you read.
- Understand API Server without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Gateway
- The process that connects Hermes to channels such as Telegram or Discord and routes messages.
Expose hermes-agent as an OpenAI-compatible API for any frontend
What does the source say, and in what order?
- 01Quick Start
Start here to understand the core idea or structure.
- 021. Enable the API server
Read this after the foundation, then connect it to the previous step.
- 032. Start the gateway
Read this after the foundation, then connect it to the previous step.
- 043. Connect a frontend
Read this after the foundation, then connect it to the previous step.
- 05Endpoints
Read this after the foundation, then connect it to the previous step.
- 06POST /v1/chat/completions
Read this after the foundation, then connect it to the previous step.
- 07POST /v1/responses
Read this after the foundation, then connect it to the previous step.
- 08Multi-turn with previousresponseid
Read this after the foundation, then connect it to the previous step.
- 09Named conversations
Read this after the foundation, then connect it to the previous step.
- 10GET /v1/responses/\id\
Finish here to verify the result and special cases.
Copy only after you understand the effect.
API_SERVER_ENABLED=true
API_SERVER_KEY=change-me-local-dev
# Optional: only if a browser must call Hermes directly
# API_SERVER_CORS_ORIGINS=http://localhost:3000hermes gateway[API Server] API server listening on http://127.0.0.1:8642Read the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.