> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myrmagent.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 认证

> API 认证与密钥管理。

# 认证

## API 密钥

在 GUI **设置 > 集成 > 智能体 API** 中生成 API 密钥。每个密钥以 `sk-myrm-` 开头，明文仅在创建时展示一次。

## 用法

在 `Authorization` 头中携带密钥：

```bash theme={null}
Authorization: Bearer sk-myrm-...
```

## 密钥管理

| 功能     | 说明                       |
| ------ | ------------------------ |
| **创建** | 设置名称、可选过期天数（1–3650 天）、备注 |
| **列表** | 查看所有密钥的前缀、状态、使用次数、最后使用时间 |
| **撤销** | 软禁用密钥（保留历史记录）            |
| **删除** | 永久移除密钥                   |
| **安全** | SHA-256 哈希存储，明文仅创建时展示一次  |

## OpenAI 兼容 API

Myrm 提供 OpenAI 兼容的 **Agent API**（`/v1`）。外部工具调用已配置智能体（记忆、工具、技能），不是裸 LLM 转发：

```bash theme={null}
curl http://localhost:8080/v1/chat/completions \
  -H "Authorization: Bearer sk-myrm-..." \
  -H "Content-Type: application/json" \
  -d '{"model": "default", "messages": [{"role": "user", "content": "你好"}], "stream": true}'
```

### Agent API 与 LLM 代理分工

* **Agent API（Myrm `/v1`）**：`model` 为 Agent ID 或 `"default"` → 完整 Agent 执行引擎。
* **LLM 代理（Cursor/Codex）**：跨 Provider 原始 LLM 路由不在 Myrm 产品范围内，请使用独立的外部 LLM 网关。

## 交互式 API 文档（Swagger UI）

访问 `http://localhost:8080/docs` 可在交互式 Swagger UI 中浏览完整 API。

| 部署模式             | 认证方式                                     |
| ---------------- | ---------------------------------------- |
| **本地 / Tauri**   | 无需 token — loopback 请求自动信任               |
| **WebUI 远程**     | 先登录，session cookie 自动携带                  |
| **沙箱 / API Key** | 点击 **Authorize**，输入 API Key，点击 **Apply** |

授权后，每次 **Try it out → Execute** 调用都会自动携带 `Authorization: Bearer <key>` 请求头。端点旁的锁图标会指示当前凭据状态。

ReDoc 文档也可在 `http://localhost:8080/redoc` 访问。

## 密钥轮换

可在 API Keys 设置页随时撤销或删除密钥，被撤销的密钥立即拒绝访问。