指南

指南页为第三方客户端接入 ATM Gateway 提供配置片段,基于本机已签发的真实 Key 自动生成,可直接复制使用。

适用场景

  • 配置 ATM 已原生支持的一线工具 → 参阅 接入指南
  • 配置接入列表以外的第三方工具 → 从本页获取配置片段。

片段中显示的 atm-xxx 为真实 Key 的遮罩形式;复制 操作导出未遮罩的完整值。

生成内容

针对所选 Agent 和协议,指南页生成以下内容:

  1. curl 连通性验证命令 — 携带正确鉴权头,访问对应的 Gateway 端点。
  2. 最小配置片段 — 覆盖主流第三方客户端接受的格式(jsontoml、环境变量)。
  3. 协议说明 — 说明请求头、模型 ID 及相关转换注意事项。

配置示例

OpenAI Chat 兼容客户端

适用于大多数通用第三方客户端。

curl -s -X POST http://127.0.0.1:4317/v1/chat/completions \
  -H 'Authorization: Bearer atm-xxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "messages": [
      {"role": "user", "content": "Reply with exactly: pong"}
    ]
  }'

JSON 配置:

{
  "baseUrl": "http://127.0.0.1:4317/v1",
  "apiKey": "atm-xxxxxxxxxxxx"
}

Anthropic Messages 兼容客户端

curl -s -X POST http://127.0.0.1:4317/v1/messages \
  -H 'x-api-key: atm-xxxxxxxxxxxx' \
  -H 'anthropic-version: 2023-06-01' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "<your-model-id>",
    "max_tokens": 64,
    "messages": [
      {"role": "user", "content": "Reply with exactly: pong"}
    ]
  }'

环境变量(Claude Code 风格):

ANTHROPIC_BASE_URL=http://127.0.0.1:4317
ANTHROPIC_AUTH_TOKEN=atm-xxxxxxxxxxxx
ANTHROPIC_API_KEY=atm-xxxxxxxxxxxx

Gemini generateContent 兼容客户端

curl -s -X POST \
  "http://127.0.0.1:4317/v1beta/models/<your-model-id>:generateContent" \
  -H 'x-goog-api-key: atm-xxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "contents": [
      {"parts": [{"text": "Reply with exactly: pong"}]}
    ]
  }'

OpenAI Responses(Codex 风格)

curl -s -X POST http://127.0.0.1:4317/v1/responses \
  -H 'Authorization: Bearer atm-xxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "<your-model-id>",
    "input": "Reply with exactly: pong"
  }'

配置约束

Base URL 必须指向 ATM。 若客户端的 Base URL 为 https://api.openai.com/v1,请求绕过 ATM,日志与用量均不被记录。

请求头须与端点匹配。 Authorization: Bearer … 适用于所有端点;原生请求头(x-api-keyx-goog-api-key)仅在对应端点有效。

请求体格式须与路径匹配。 Anthropic 格式的请求体发至 /v1/chat/completions 将被拒绝;ATM 不执行请求体的隐式转换。

验证接入

应用配置片段后,发起一次真实请求,并执行以下验证:

  1. 打开 日志 页,新记录应在数秒内出现。
  2. 若无记录,执行 GET /api/logs?agent_id=<your_agent_id>&limit=5 查看 Gateway 侧的最近日志。
  3. 若 Gateway 始终未收到请求,表明客户端仍指向上游——请重新确认 baseUrl 配置。

results matching ""

    No results matching ""