奥特曼AI 文档中心

快速接入

通过 atmai-auto 一键部署 / 一键配置

如果你使用 Claude Code、Codex、OpenCode、OpenClaw 或 Hermes Agent，推荐直接运行 ATMAI 一键配置工具。不会写代码也可以照下面步骤操作。

npx atmai-auto

1. 运行后如果出现 Need to install the following packages，输入 y 并回车。
2. 用键盘上下箭头选择你要配置的工具，例如 Claude Code、Codex、OpenCode、OpenClaw 或 Hermes Agent。
3. 复制你在奥特曼AI控制台创建的 API Key，粘贴到命令窗口里并回车。
4. 看到“配置完成”后，关闭并重新打开对应客户端。
5. 如果后续换了新的 API Key，重新运行一次 npx atmai-auto 覆盖配置即可。

接口地址

大多数 OpenAI 兼容客户端填写下面这个地址：

如果软件会自动拼接 /v1，则填写：

如果软件要求填写完整接口地址，可以填写：

客户端配置

服务类型：OpenAI Compatible
API 地址：https://api.atmai.site/v1
API Key：你的奥特曼AI密钥

接口地址：https://api.atmai.site
或：https://api.atmai.site/v1
API Key：你的奥特曼AI密钥

Base URL：https://api.atmai.site/v1
API Key：你的奥特曼AI密钥
保存后刷新模型列表

模型供应商：OpenAI-compatible
Base URL：https://api.atmai.site/v1
API Key：你的奥特曼AI密钥

Codex CLI 配置使用教程

Codex CLI 适合开发者在终端里进行代码生成、项目修改、代码解释和调试。推荐优先使用一键配置：

npx atmai-auto

手动配置 config.toml

如果需要手动配置，可以在用户目录下创建或编辑 .codex/config.toml。

model = "gpt-5.5"
model_provider = "atmai"
model_reasoning_effort = "high"
sandbox_mode = "workspace-write"
approval_policy = "on-request"
file_opener = "vscode"
web_search = "cached"
suppress_unstable_features_warning = true

[history]
persistence = "save-all"

[tui]
notifications = true

[shell_environment_policy]
inherit = "all"
ignore_default_excludes = false

[features]
unified_exec = false

[model_providers.atmai]
name = "atmai"
base_url = "https://api.atmai.site"
wire_api = "responses"
requires_openai_auth = true

配置 auth.json

{
  "OPENAI_API_KEY": "sk-xxxxxxxxxxxxxxxxxxxxxxxx"
}

Codex App 桌面客户端配置方式

如果你使用 Codex App 桌面客户端，核心思路是在用户目录下创建 .codex 文件夹，并放入 auth.json 和 config.toml 两个配置文件。

1. 退出 Codex App 当前登录状态。
2. 创建或备份 .codex 目录。
3. 写入上一节的 config.toml 和 auth.json。
4. 完全退出 Codex App 后重新打开。

OpenClaw 接入指南

OpenClaw 适合需要本地或服务器部署网页聊天界面的用户。推荐通过 ATMAI 一键配置工具写入配置。

npx atmai-auto

基础环境检查

git --version
node -v
npm -v

手动配置示例

{
  "models": {
    "providers": {
      "atmai": {
        "baseUrl": "https://api.atmai.site/v1",
        "apiKey": "sk-xxxxxxxxxxxxxxxxxxxxxxxx",
        "auth": "api-key",
        "api": "openai-responses",
        "authHeader": true,
        "headers": {
          "User-Agent": "OpenClaw",
          "Accept": "application/json"
        }
      }
    }
  }
}

接口示例

获取模型列表

curl https://api.atmai.site/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

Chat Completions

curl https://api.atmai.site/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.5",
    "messages": [
      {"role": "user", "content": "你好"}
    ],
    "stream": true
  }'

Python SDK

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.atmai.site/v1"
)

response = client.chat.completions.create(
    model="gpt-5.5",
    messages=[{"role": "user", "content": "你好"}]
)

print(response.choices[0].message.content)

JavaScript SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "YOUR_API_KEY",
  baseURL: "https://api.atmai.site/v1"
});

const response = await client.chat.completions.create({
  model: "gpt-5.5",
  messages: [{ role: "user", content: "你好" }]
});

console.log(response.choices[0].message.content);

计费说明

平台采用按量计费。实际消耗通常和输入 tokens、输出 tokens、图片、文件、长上下文等能力有关。

• 低倍率通道更适合日常聊天、批量处理和新手测试。
• 高倍率通道更适合复杂代码、长文分析和高质量输出。
• 余额不足时可能返回 INSUFFICIENT_BALANCE。
• 建议在生产环境中记录 Request ID、耗时和费用，方便排查问题。

常见错误

使用规范

• 不要公开分享 API Key。
• 不要把 API Key 写进前端网页、公开仓库或聊天截图。
• 不要高频并发压测平台。
• 不要使用平台进行违法违规、攻击、诈骗、垃圾信息等用途。
• 生产环境建议在服务端转发请求，并设置超时、重试和备用通道。

技术支持

联系管理员时，请尽量提供下面信息，方便快速定位问题。不要把完整 API Key 发给任何人。

账号邮箱：
使用的软件：
接口地址：
报错截图：
报错时间：
Request ID：
是否测试过其他请求：