Skip to content

Commit f158f6f

Browse files
Merge pull request #457 from sosidudku1/docs/atomic-agent-integration
Add Atomic Agent integration guide
2 parents b72c065 + 3c451ed commit f158f6f

4 files changed

Lines changed: 169 additions & 1 deletion

File tree

19.3 KB
Loading

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -765,6 +765,7 @@
765765
* [Our Integration List](integrations/our-integration-list.md)
766766
* [Agno](integrations/agno.md)
767767
* [Aider](integrations/aider.md)
768+
* [⚛️ Atomic Agent](integrations/atomic-agent.md)
768769
* [AutoGPT](integrations/autogpt.md)
769770
* [Browser Use](integrations/browser-use.md)
770771
* [Cline](integrations/cline.md)

docs/integrations/atomic-agent.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# ⚛️ Atomic Agent
2+
3+
<div align="left" data-with-frame="false"><figure><img src="../.gitbook/assets/atomic-agent-logo.png" alt="Atomic Agent logo" width="188"><figcaption></figcaption></figure></div>
4+
5+
## About
6+
7+
Atomic Agent is an open-source, local-first AI agent that runs on your computer. It plans multi-step tasks and executes them with real tools: shell, files, browser automation, skills, and MCP servers. All agent state, memory, and configuration live on your machine in `~/.atomic-agent`.
8+
9+
Atomic Agent can run open models fully locally through a built-in llama.cpp backend, or connect to cloud models. AI/ML API is a **native built-in provider**: one API key gives the agent access to 500+ models, including GPT, Claude, Gemini, Qwen, and Grok families, with no endpoint configuration.
10+
11+
Atomic Agent is MIT-licensed and available for macOS, Linux, and Windows.
12+
13+
{% hint style="success" %}
14+
**No native Anthropic or Google provider exists in Atomic Agent.** AI/ML API is the built-in way to use Claude and Gemini models with it.
15+
{% endhint %}
16+
17+
### What you get
18+
19+
* A terminal agent (CLI + TUI) that plans and executes multi-step tasks
20+
* Tool use out of the box: shell, file operations, browser automation, skills, MCP servers
21+
* Local-first state: config, memory, and sessions stored in `~/.atomic-agent`
22+
* Mix of local and cloud models in one app (for example, local embeddings + cloud chat)
23+
* Live model catalog: the provider fetches the current AI/ML API model list at setup time
24+
* Telegram connector and an OpenAI-compatible local HTTP server
25+
* MIT license, installs without an account
26+
27+
***
28+
29+
## Quick Install
30+
31+
One command, no account or key required:
32+
33+
```sh
34+
# macOS / Linux
35+
curl -fsSL https://atomicagent.io/install | sh
36+
```
37+
38+
```powershell
39+
# Windows
40+
irm https://atomicagent.io/install.ps1 | iex
41+
```
42+
43+
***
44+
45+
## Configuration
46+
47+
You will need an AIMLAPI key from your [account dashboard](https://aimlapi.com/app/keys).
48+
49+
### Option 1: Built-in provider wizard (recommended)
50+
51+
Atomic Agent ships with a native AI/ML API provider, so there is nothing to configure by hand.
52+
53+
1. Run `atomic-agent tui`.
54+
2. Type `/model` to open the LLM Local/Cloud panel.
55+
3. Select **AI/ML API (aimlapi.com — 500+ models, OpenAI-compatible)**.
56+
4. Paste your API key when prompted.
57+
5. Pick a chat model. The list is fetched live from the AI/ML API, so new models appear as soon as they are released.
58+
59+
The wizard stores the key as `AIMLAPI_API_KEY` in `~/.atomic-agent/.env` and writes the provider entry to `~/.atomic-agent/config.json`.
60+
61+
### Option 2: Manual configuration
62+
63+
Add the provider to the `llm` block of `~/.atomic-agent/config.json`:
64+
65+
```json
66+
{
67+
"llm": {
68+
"activeTextProvider": "aimlapi",
69+
"activeEmbeddingProvider": "local-llama",
70+
"toolTransport": "auto",
71+
"providers": [
72+
{
73+
"id": "aimlapi",
74+
"kind": "aimlapi",
75+
"defaultChatModel": "openai/gpt-5.5-2026-04-23"
76+
}
77+
]
78+
}
79+
}
80+
```
81+
82+
Then put your key in `~/.atomic-agent/.env`:
83+
84+
```sh
85+
AIMLAPI_API_KEY=your_key_here
86+
```
87+
88+
The base URL (`https://api.aimlapi.com`) is built into the provider; you do not need to set it.
89+
90+
{% hint style="info" %}
91+
If you prefer the generic `"kind": "openai-compatible"` provider instead, set `"baseUrl": "https://api.aimlapi.com"` **without** the `/v1` suffix. Atomic Agent appends `/v1/chat/completions` itself, and a doubled path returns 404. That provider kind reads its key from `OPENAI_COMPAT_API_KEY`.
92+
{% endhint %}
93+
94+
***
95+
96+
## Model Selection
97+
98+
* Default chat model for the AI/ML API provider: `openai/gpt-5.5-2026-04-23`.
99+
* Any model ID from the [AI/ML API catalog](https://aimlapi.com/models) works, for example `anthropic/claude-sonnet-4-5` or `alibaba/qwen3.8-max-preview`. The configured model ID is sent to the API as-is, so you are not limited to the bundled list.
100+
* Embedding models from the AI/ML API catalog can be selected too, or embeddings can stay on the local llama-server daemon.
101+
* For cloud models, Atomic Agent uses native function calling, so tool use works out of the box.
102+
103+
***
104+
105+
## Verification
106+
107+
Start a session:
108+
109+
```sh
110+
atomic-agent tui
111+
```
112+
113+
Ask for something that requires a tool call, for example: "list the files in this folder and summarize them". If the model responds and tools execute, the integration is working.
114+
115+
***
116+
117+
## Use Cases
118+
119+
* **Frontier models inside a local agent.** Keep the agent runtime, tools, and files on your machine while using top cloud models for reasoning.
120+
* **Claude and Gemini in Atomic Agent.** These model families are only reachable through an aggregator; AI/ML API is the supported path.
121+
* **One key, many models.** Switch between model families without separate accounts and billing per provider.
122+
* **Mixed setups.** Run embeddings locally and chat in the cloud, or the other way around.
123+
124+
***
125+
126+
## Troubleshooting
127+
128+
<details>
129+
130+
<summary>401 / authentication errors</summary>
131+
132+
Check that `AIMLAPI_API_KEY` is present in `~/.atomic-agent/.env` and has no extra whitespace. Re-entering the key via the `/model` wizard rewrites it correctly.
133+
134+
</details>
135+
136+
<details>
137+
138+
<summary>404 on chat requests (manual openai-compatible setup)</summary>
139+
140+
Remove the `/v1` suffix from `baseUrl`. The agent appends `/v1/chat/completions` itself.
141+
142+
</details>
143+
144+
<details>
145+
146+
<summary>Model not found</summary>
147+
148+
Verify the exact model ID against the [AI/ML API models list](https://aimlapi.com/models). The ID is passed to the API verbatim.
149+
150+
</details>
151+
152+
<details>
153+
154+
<summary>Switching provider or model later</summary>
155+
156+
Open `/model` in the TUI at any time to change the provider or the chat model. No restart is required.
157+
158+
</details>
159+
160+
***
161+
162+
## Links
163+
164+
* Website: [atomicagent.io](https://atomicagent.io)
165+
* GitHub: [github.com/AtomicBot-ai/atomic-agent](https://github.com/AtomicBot-ai/atomic-agent)
166+
* Discord: [discord.gg/Us7qXtDGw](https://discord.gg/Us7qXtDGw)
167+
* X: [@atomicagent_io](https://x.com/atomicagent_io)

0 commit comments

Comments
 (0)