shootstuff commited on
Commit
5fc026e
·
verified ·
1 Parent(s): ca48554

Add Space README with Docker config

Browse files
Files changed (1) hide show
  1. README.md +40 -5
README.md CHANGED
@@ -1,10 +1,45 @@
1
  ---
2
- title: Hermes Agent Api
3
- emoji: 😻
4
- colorFrom: pink
5
- colorTo: yellow
6
  sdk: docker
 
7
  pinned: false
 
8
  ---
9
 
10
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: Hermes Agent API
3
+ emoji:
4
+ colorFrom: indigo
5
+ colorTo: purple
6
  sdk: docker
7
+ app_port: 7860
8
  pinned: false
9
+ license: mit
10
  ---
11
 
12
+ # Hermes Agent API
13
+
14
+ A deployment-agnostic HTTP API around the [Hermes agent](https://github.com/morongosteve/hermes-agent).
15
+ The image clones the agent at build time, installs it, and serves `api_server.py`.
16
+
17
+ ## Endpoints
18
+
19
+ - `GET /health` — liveness probe (always 200 once up)
20
+ - `GET /` — JSON service/route description
21
+ - `POST /v1/agent` — native Hermes turn
22
+ - `POST /v1/chat/completions` — OpenAI-compatible chat completions (non-streaming)
23
+
24
+ ## Configuration (Space secrets / variables)
25
+
26
+ Set these under **Settings → Variables and secrets**:
27
+
28
+ - `OPENROUTER_API_KEY` *(secret, required for the agent to answer)* — upstream model key
29
+ - `HERMES_MODEL` *(optional)* — default model (default `anthropic/claude-opus-4.6`)
30
+ - `HERMES_SERVER_API_KEY` *(optional)* — if set, callers must send it as
31
+ `Authorization: Bearer <key>` or `X-API-Key`
32
+ - `HERMES_ENABLED_TOOLSETS` / `HERMES_DISABLED_TOOLSETS` *(optional)*
33
+
34
+ The API comes up healthy immediately; the agent endpoints start answering once
35
+ `OPENROUTER_API_KEY` is set.
36
+
37
+ ## Example
38
+
39
+ ```bash
40
+ curl -s https://shootstuff-hermes-agent-api.hf.space/health
41
+
42
+ curl -s -X POST https://shootstuff-hermes-agent-api.hf.space/v1/chat/completions \
43
+ -H "Content-Type: application/json" \
44
+ -d '{"messages":[{"role":"user","content":"hello"}]}'
45
+ ```