> For the complete documentation index, see [llms.txt](https://gitbook.lizh.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.lizh.ai/hermes.md).

# Hermes

Hermes can be configured with an OpenAI-compatible endpoint when the provider settings allow a custom base URL, API key, and model name.

## Values

```yaml
base_url: https://lizh.ai/v1
api_key: ${LIZH_API_KEY}
model: kimi-k3
```

The sample file is available at [`config/hermes.example.yaml`](https://github.com/Fankouzu/kimi-k3-openai-compatible-examples/tree/main/config/hermes.example.yaml).

## Setup

1. Create an API key at <https://lizh.ai/keys>.
2. Set `LIZH_API_KEY` in your shell or secret manager.
3. Configure Hermes with `https://lizh.ai/v1` as the base URL.
4. Set the model name to `kimi-k3`.
5. Start with a short prompt before testing long-context tasks.

## Notes

If Hermes has separate provider choices, select an OpenAI-compatible or custom OpenAI provider rather than an official OpenAI-only preset.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.lizh.ai/hermes.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.