Skip to content

Commit 93eccfc

Browse files
kristinaorekhovagitbook-bot
kristinaorekhova
authored and
gitbook-bot
committed
GITBOOK-1090: No subject
1 parent 661a300 commit 93eccfc

3 files changed

Lines changed: 186 additions & 1 deletion

File tree

‎docs/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,7 @@
599599
* [ElizaOS](integrations/elizaos.md)
600600
* [GPT Researcher (gptr)](integrations/gpt-researcher-gptr.md)
601601
* [Hermes](integrations/hermes.md)
602+
* [Hermes Desktop](integrations/hermes-desktop.md)
602603
* [Kilo Code](integrations/kilo-code.md)
603604
* [Langflow](integrations/langflow.md)
604605
* [LiteLLM](integrations/litellm.md)

‎docs/integrations/hermes-desktop.md‎

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
# Hermes Desktop
2+
3+
## About
4+
5+
[Hermes Desktop](https://github.com/fathah/hermes-desktop) is a native desktop app for installing, configuring, and chatting with [Hermes Agent](https://github.com/NousResearch/hermes-agent). It provides a GUI for provider setup, model selection, sessions, tools, skills, and messaging gateways — without having to manage the CLI by hand.
6+
7+
As of [PR #612](https://github.com/fathah/hermes-desktop/pull/612) (merged June 9, 2026), AI/ML API is a built-in provider preset in Hermes Desktop. You can select it from the provider list during first-run setup or at any time in Settings.
8+
9+
## Quick start
10+
11+
1. Download and install Hermes Desktop from [hermesagents.cc](https://hermesagents.cc/).
12+
2. Open the app. On first launch it runs the setup wizard.
13+
3. When prompted for a provider, choose **AI/ML API**.
14+
4. Enter your AI/ML API key.
15+
5. Pick a model and start chatting.
16+
17+
## When to use AI/ML API with Hermes Desktop
18+
19+
AI/ML API works well with Hermes Desktop when you want:
20+
21+
* one key for many model providers
22+
* an OpenAI-compatible endpoint with no custom configuration
23+
* fast switching between coding, reasoning, and multimodal models from a GUI
24+
25+
## Prerequisites
26+
27+
Before you start, make sure you have:
28+
29+
* Hermes Desktop installed ([hermesagents.cc](https://hermesagents.cc/))
30+
* an AI/ML API key from [aimlapi.com/app/keys](https://aimlapi.com/app/keys)
31+
* a model ID from [aimlapi.com/models](https://aimlapi.com/models)
32+
33+
The base URL is:
34+
35+
```bash
36+
https://api.aimlapi.com/v1
37+
```
38+
39+
Need a key first? Use [API Key Management](/broken/pages/b1dbdf89b3ed7f9af9a90506fe3124b622cfc559).
40+
41+
## Set up AI/ML API in Hermes Desktop
42+
43+
### First-run setup wizard
44+
45+
When Hermes Desktop opens for the first time:
46+
47+
1. Choose **Local** mode (runs Hermes Agent at `127.0.0.1:8642`) or **Remote** mode (connects to a hosted Hermes API server).
48+
2. At the provider step, select **AI/ML API** from the list.
49+
3. Enter your `AIMLAPI_API_KEY` in the key field.
50+
4. Pick a model from the auto-discovered model list.
51+
5. Complete setup. The app saves your config and opens the workspace.
52+
53+
### Change provider in Settings
54+
55+
To switch to AI/ML API after initial setup:
56+
57+
1. Open **Settings** → **Provider**.
58+
2. Select **AI/ML API**.
59+
3. Enter your `AIMLAPI_API_KEY`.
60+
4. Save.
61+
62+
### Saved configuration
63+
64+
Hermes Desktop stores provider config in the standard Hermes files under `~/.hermes/`:
65+
66+
`~/.hermes/.env`:
67+
68+
```bash
69+
AIMLAPI_API_KEY=your_key_here
70+
```
71+
72+
`~/.hermes/config.yaml`:
73+
74+
```yaml
75+
model:
76+
provider: aimlapi
77+
base_url: https://api.aimlapi.com/v1
78+
default: openai/gpt-4o
79+
```
80+
81+
### How the CLI bridge works
82+
83+
The Hermes Agent CLI does not yet have a native `aimlapi` provider ID. Hermes Desktop bridges this by routing AI/ML API traffic through `--provider custom`, passing `CUSTOM_BASE_URL` and mapping `AIMLAPI_API_KEY` to `OPENAI_API_KEY` so the CLI can authenticate. This is transparent — from the desktop UI it behaves like any other built-in provider.
84+
85+
## Model selection
86+
87+
Use exact AI/ML API model IDs. Hermes Desktop auto-discovers available models from `/v1/models` — no hardcoded model list.
88+
89+
Common examples:
90+
91+
* `openai/gpt-4o`
92+
* `anthropic/claude-sonnet-4-5`
93+
* `google/gemini-2.5-flash`
94+
95+
### Good starting models
96+
97+
* `openai/gpt-4o` for strong general use
98+
* `anthropic/claude-sonnet-4-5` for coding and long-form work
99+
* `google/gemini-2.5-flash` for lower latency and lower cost
100+
101+
For the full catalog, use [All Model IDs](/broken/pages/ec6db764340ce0627cef7e114fb5a65a73cafbf4).
102+
103+
## Switch models
104+
105+
Open the **Models** screen to manage saved model configurations per provider. To change the active model mid-session, use the `/model` slash command in chat:
106+
107+
```bash
108+
/model openai/gpt-4o
109+
/model anthropic/claude-sonnet-4-5
110+
```
111+
112+
## Verify the setup
113+
114+
After setup, open a chat and send a message. If the model responds normally, the provider is configured correctly.
115+
116+
You can also check the active provider and model from the chat footer or with the `/status` slash command.
117+
118+
## Config checklist
119+
120+
Make sure these values are set:
121+
122+
* base URL: `https://api.aimlapi.com/v1`
123+
* provider: `AI/ML API` (shown as `aimlapi` in config files)
124+
* model ID: exact AI/ML API model ID
125+
* API key variable: `AIMLAPI_API_KEY`
126+
127+
## Troubleshooting
128+
129+
<details>
130+
131+
<summary>AI/ML API does not appear in the provider list</summary>
132+
133+
The preset was added in [PR #612](https://github.com/fathah/hermes-desktop/pull/612). Update Hermes Desktop to the latest version from [hermesagents.cc](https://hermesagents.cc/) or the [releases page](https://github.com/fathah/hermes-desktop/releases).
134+
135+
</details>
136+
137+
<details>
138+
139+
<summary>My model is missing from the picker</summary>
140+
141+
The model list is pulled live from `/v1/models`. If a model does not appear, set it manually in `~/.hermes/config.yaml`:
142+
143+
```yaml
144+
model:
145+
default: openai/gpt-4o
146+
```
147+
148+
</details>
149+
150+
<details>
151+
152+
<summary>I get an auth error</summary>
153+
154+
Check that:
155+
156+
* `AIMLAPI_API_KEY` is set in `~/.hermes/.env`
157+
* the key is valid at [aimlapi.com/app/keys](https://aimlapi.com/app/keys)
158+
* no other provider is overriding the env key
159+
160+
Use **Settings → Backup & Debug → Debug dump** for a full diagnostics report.
161+
162+
</details>
163+
164+
<details>
165+
166+
<summary>I want to use a proxy</summary>
167+
168+
Set a custom base URL in `~/.hermes/config.yaml`:
169+
170+
```yaml
171+
model:
172+
base_url: https://your-proxy.example/v1
173+
```
174+
175+
</details>
176+
177+
## Links
178+
179+
* [All Model IDs](/broken/pages/ec6db764340ce0627cef7e114fb5a65a73cafbf4)
180+
* [AI/ML API keys](https://aimlapi.com/app/keys)
181+
* [AI/ML API model catalog](https://aimlapi.com/models)
182+
* [Hermes Desktop repository](https://github.com/fathah/hermes-desktop)
183+
* [Hermes Desktop releases](https://github.com/fathah/hermes-desktop/releases)
184+
* [Hermes Agent repository](https://github.com/NousResearch/hermes-agent)

‎docs/integrations/our-integration-list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ description: About third-party integrations
66

77
Our API endpoint can be integrated with popular AI workflow platforms and tools, allowing their users to access our models through these environments.
88

9-
<table><thead><tr><th width="124">Service</th><th>Description</th></tr></thead><tbody><tr><td><a href="agno.md">Agno</a></td><td>A lightweight library for building agents — AI programs that operate autonomously, use tools, and have memory, knowledge, storage, and reasoning capabilities.</td></tr><tr><td><a href="aider.md">Aider</a></td><td>A command-line pair programming tool that connects to OpenAI-compatible APIs. It lets you chat with models to edit your codebase, auto-commit changes, and build software collaboratively from the terminal.</td></tr><tr><td><a href="autogpt.md">AutoGPT</a></td><td>An open-source platform designed to help you build, test, and run AI agents using a no-code visual interface. It allows users to link LLMs with tools, memory, planning modules, and action chains.</td></tr><tr><td><a href="browser-use.md">Browser Use</a></td><td>An LLM-powered browser automation tool that allows language models to control a real browser via structured system and user prompts. The LLM decides which browser actions to perform (open pages, navigate, click, read content), while the execution is handled by the browser runtime. The integration works with any supported LLM and does not rely on model-specific features.</td></tr><tr><td><a href="claude-code.md">Claude Code</a></td><td>A powerful coding agent by Anthropic that can analyze codebases, generate code, and assist with development workflows. By pointing it to AIML API, you can use Claude models available on our platform without connecting directly to Anthropic.</td></tr><tr><td><a href="cline.md">Cline</a></td><td>An open-source AI coding assistant with two working modes (Plan/Act), terminal command execution, and support for the Model Context Protocol (MCP) in VS Code.</td></tr><tr><td><a href="continue.dev.md">continue.dev</a></td><td>An open-source IDE extension and hub for rules, tools, and models that let you create, share, and use custom AI code assistants.</td></tr><tr><td><a href="elizaos.md">ElizaOS</a></td><td>A powerful multi-agent simulation framework designed to create, deploy, and manage autonomous AI agents. Built with TypeScript, it provides a flexible and extensible platform for developing intelligent agents that can interact across multiple platforms while maintaining consistent personalities and knowledge.</td></tr><tr><td><a href="gpt-researcher-gptr.md">GPT Researcher</a></td><td>An autonomous agent that takes care of the tedious task of research for you, by scraping, filtering and aggregating over 20+ web sources per a single research task.</td></tr><tr><td><a href="hermes.md">Hermes</a></td><td>An agent framework for CLI and messaging workflows that supports OpenAI-compatible providers. It can connect to AI/ML API through a native provider fork or a manual custom backend setup.</td></tr><tr><td><a href="kilo-code.md">Kilo Code</a></td><td>An open-source AI coding assistant and VS Code extension that enables natural-language code generation, debugging, and refactoring through customizable modes (Architect, Code, Debug, etc.). It supports multiple model providers, integrates with the Model Context Protocol (MCP), and allows developers to extend functionality with custom tools and workflows.</td></tr><tr><td><a href="langflow.md">Langflow</a></td><td>A new visual framework for building multi-agent and RAG applications. It is open-source, Python-powered, fully customizable, and LLM and vector store agnostic. Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions.</td></tr><tr><td><a href="litellm.md">LiteLLM</a></td><td>An open-source Python library that provides a unified API for interacting with multiple large language model providers. It allows developers to switch between different models with minimal code changes, optimizing cost and performance. LiteLLM simplifies integration by offering a single interface for various LLM endpoints, enabling seamless experimentation and deployment across different AI providers.</td></tr><tr><td><a href="make.md">Make</a></td><td>A powerful, enterprise-scale automation platform. It offers flow control, data manipulation, HTTP/webhooks, AI agents and tools, notes, an MCP server, and many other features at your service.</td></tr><tr><td><a href="manus.md">Manus</a></td><td>A workflow and AI-agent orchestration platform that lets users integrate custom APIs, define automation logic, and run LLM-powered tools inside a unified interface. Manus supports custom model backends (such as AI/ML API), prompt templates, request routing, secure secret storage, and visual debugging.</td></tr><tr><td><a href="marvin.md">Marvin</a></td><td>A Python framework by PrefectHQ for building agentic AI workflows and producing structured outputs. It allows developers to define <em>Tasks</em> (objective-focused units of work) and assign them to specialized <em>Agents</em> (LLM-powered configurations). Marvin supports type-safe results via Pydantic models, integrates with multiple LLM providers through Pydantic AI, and enables orchestration of multi-agent threads for complex workflows.</td></tr><tr><td><a href="n8n.md">n8n</a></td><td>An open-source workflow automation tool that lets you connect various services and automate tasks without writing full integrations manually.</td></tr><tr><td><a href="openclaw.md">OpenClaw</a></td><td><p>A personal AI assistant that runs on your own devices and connects to popular messaging platforms (such as WhatsApp, Telegram, Slack, Discord, and others) while preserving full data privacy (all agent data is stored locally in a SQLite database).</p><p>Developers use OpenClaw to build multi-channel AI assistants with streaming responses, browser automation, vision, and voice features. It includes a local Gateway service, a CLI for management, and support for 12+ messaging platforms.</p></td></tr><tr><td><a href="roo-code.md">Roo Code</a></td><td>An autonomous AI programming agent that works right inside your editor, such as VS Code. It helps you code faster and smarter — whether you're starting a new project, maintaining existing code, or exploring new technologies.</td></tr><tr><td><a href="sillytavern.md">SillyTavern</a></td><td>A locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. Integration with the AI/ML API currently applies only to LLMs.</td></tr><tr><td><a href="toolhouse.md">Toolhouse</a></td><td>A Backend-as-a-Service (BaaS) to build, run, and manage AI agents. Toolhouse simplifies the process of building agents in a local environment and running them in production.</td></tr></tbody></table>
9+
<table><thead><tr><th width="124">Service</th><th>Description</th></tr></thead><tbody><tr><td><a href="agno.md">Agno</a></td><td>A lightweight library for building agents — AI programs that operate autonomously, use tools, and have memory, knowledge, storage, and reasoning capabilities.</td></tr><tr><td><a href="aider.md">Aider</a></td><td>A command-line pair programming tool that connects to OpenAI-compatible APIs. It lets you chat with models to edit your codebase, auto-commit changes, and build software collaboratively from the terminal.</td></tr><tr><td><a href="autogpt.md">AutoGPT</a></td><td>An open-source platform designed to help you build, test, and run AI agents using a no-code visual interface. It allows users to link LLMs with tools, memory, planning modules, and action chains.</td></tr><tr><td><a href="browser-use.md">Browser Use</a></td><td>An LLM-powered browser automation tool that allows language models to control a real browser via structured system and user prompts. The LLM decides which browser actions to perform (open pages, navigate, click, read content), while the execution is handled by the browser runtime. The integration works with any supported LLM and does not rely on model-specific features.</td></tr><tr><td><a href="claude-code.md">Claude Code</a></td><td>A powerful coding agent by Anthropic that can analyze codebases, generate code, and assist with development workflows. By pointing it to AIML API, you can use Claude models available on our platform without connecting directly to Anthropic.</td></tr><tr><td><a href="cline.md">Cline</a></td><td>An open-source AI coding assistant with two working modes (Plan/Act), terminal command execution, and support for the Model Context Protocol (MCP) in VS Code.</td></tr><tr><td><a href="continue.dev.md">continue.dev</a></td><td>An open-source IDE extension and hub for rules, tools, and models that let you create, share, and use custom AI code assistants.</td></tr><tr><td><a href="elizaos.md">ElizaOS</a></td><td>A powerful multi-agent simulation framework designed to create, deploy, and manage autonomous AI agents. Built with TypeScript, it provides a flexible and extensible platform for developing intelligent agents that can interact across multiple platforms while maintaining consistent personalities and knowledge.</td></tr><tr><td><a href="gpt-researcher-gptr.md">GPT Researcher</a></td><td>An autonomous agent that takes care of the tedious task of research for you, by scraping, filtering and aggregating over 20+ web sources per a single research task.</td></tr><tr><td><a href="hermes.md">Hermes</a></td><td>An agent framework for CLI and messaging workflows that supports OpenAI-compatible providers. It can connect to AI/ML API through a native provider fork or a manual custom backend setup.</td></tr><tr><td><a href="hermes-desktop.md">Hermes Desktop</a></td><td>A native desktop app for installing, configuring, and chatting with Hermes Agent. Supports AI/ML API as a built-in provider preset for easy access to OpenAI-compatible models through a GUI.</td></tr><tr><td><a href="kilo-code.md">Kilo Code</a></td><td>An open-source AI coding assistant and VS Code extension that enables natural-language code generation, debugging, and refactoring through customizable modes (Architect, Code, Debug, etc.). It supports multiple model providers, integrates with the Model Context Protocol (MCP), and allows developers to extend functionality with custom tools and workflows.</td></tr><tr><td><a href="langflow.md">Langflow</a></td><td>A new visual framework for building multi-agent and RAG applications. It is open-source, Python-powered, fully customizable, and LLM and vector store agnostic. Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions.</td></tr><tr><td><a href="litellm.md">LiteLLM</a></td><td>An open-source Python library that provides a unified API for interacting with multiple large language model providers. It allows developers to switch between different models with minimal code changes, optimizing cost and performance. LiteLLM simplifies integration by offering a single interface for various LLM endpoints, enabling seamless experimentation and deployment across different AI providers.</td></tr><tr><td><a href="make.md">Make</a></td><td>A powerful, enterprise-scale automation platform. It offers flow control, data manipulation, HTTP/webhooks, AI agents and tools, notes, an MCP server, and many other features at your service.</td></tr><tr><td><a href="manus.md">Manus</a></td><td>A workflow and AI-agent orchestration platform that lets users integrate custom APIs, define automation logic, and run LLM-powered tools inside a unified interface. Manus supports custom model backends (such as AI/ML API), prompt templates, request routing, secure secret storage, and visual debugging.</td></tr><tr><td><a href="marvin.md">Marvin</a></td><td>A Python framework by PrefectHQ for building agentic AI workflows and producing structured outputs. It allows developers to define <em>Tasks</em> (objective-focused units of work) and assign them to specialized <em>Agents</em> (LLM-powered configurations). Marvin supports type-safe results via Pydantic models, integrates with multiple LLM providers through Pydantic AI, and enables orchestration of multi-agent threads for complex workflows.</td></tr><tr><td><a href="n8n.md">n8n</a></td><td>An open-source workflow automation tool that lets you connect various services and automate tasks without writing full integrations manually.</td></tr><tr><td><a href="openclaw.md">OpenClaw</a></td><td><p>A personal AI assistant that runs on your own devices and connects to popular messaging platforms (such as WhatsApp, Telegram, Slack, Discord, and others) while preserving full data privacy (all agent data is stored locally in a SQLite database).</p><p>Developers use OpenClaw to build multi-channel AI assistants with streaming responses, browser automation, vision, and voice features. It includes a local Gateway service, a CLI for management, and support for 12+ messaging platforms.</p></td></tr><tr><td><a href="roo-code.md">Roo Code</a></td><td>An autonomous AI programming agent that works right inside your editor, such as VS Code. It helps you code faster and smarter — whether you're starting a new project, maintaining existing code, or exploring new technologies.</td></tr><tr><td><a href="sillytavern.md">SillyTavern</a></td><td>A locally installed user interface that allows you to interact with text generation LLMs, image generation engines, and TTS voice models. Integration with the AI/ML API currently applies only to LLMs.</td></tr><tr><td><a href="toolhouse.md">Toolhouse</a></td><td>A Backend-as-a-Service (BaaS) to build, run, and manage AI agents. Toolhouse simplifies the process of building agents in a local environment and running them in production.</td></tr></tbody></table>

0 commit comments

Comments
 (0)