API 快速开始

本页面向开发者，用最小请求验证 AIDMX API 是否可用。第一次配置 Codex 或 CC Switch 的新客，建议先看新手上手。

所有示例都使用 API Base URL：

https://ai.aidmx.xyz/v1

适用场景

第一次创建 API Token 后，需要确认接口能正常返回。
需要把 AIDMX 接入自己的服务、脚本或第三方工具。
需要排查是账号问题、Token 问题还是客户端配置问题。

前置条件

已登录控制台。
已在令牌管理创建 API Token。
已确认价格页或控制台中存在你要调用的模型。

操作步骤

设置环境变量，避免把 Token 写进代码仓库。

bash

export AIDMX_API_KEY="你的 API Token"
export AIDMX_MODEL="控制台可用的模型名称"

发起一次 OpenAI 兼容的 Chat Completions 请求。

流式输出提示

部分模型当前以流式输出为准。

命令行测试建议显式传入 "stream": true，并使用 curl -N 关闭缓冲。

返回内容是 SSE 事件流，每行通常以 data: 开头，读取到 data: [DONE] 表示完成；如果客户端按普通 JSON 解析，可能会看到 Unexpected token 'd'。

bash

curl -N https://ai.aidmx.xyz/v1/chat/completions \
  -H "Authorization: Bearer $AIDMX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$AIDMX_MODEL"'",
    "messages": [
      {
        "role": "user",
        "content": "用一句话介绍 AIDMX。"
      }
    ]
  }'

如果你使用 SDK，把 baseURL 或 base_url 设置为 https://ai.aidmx.xyz/v1，把 API Key 设置为控制台生成的 Token。

创建 Token 前，先进入令牌管理页，确认列表、复制按钮和新增入口的位置。这是 API 调用里最关键的凭证入口。

令牌管理列表和新增入口

创建成功后只保留必要的复制动作，随后立刻用 Authorization: Bearer <Token> 发起测试请求。

成功验证

HTTP 状态码为 200。
响应中包含 choices 或等价的模型输出字段。
使用日志中能看到本次请求的模型、时间和消耗。

常见失败

Unauthorized 或 401：确认 Header 是 Authorization: Bearer <Token>。
model not found：模型名称必须与控制台可用模型一致，不能只填写展示名。
quota exceeded 或余额不足：查看钱包充值和令牌限额。
请求超时：检查本地网络、代理、防火墙，以及工具是否支持自定义 Base URL。

下一步

阅读 API Token，了解 Token 的创建、限额和管理。
前往模型广场查看可用模型及价格。
阅读 AI 应用，将 API 接入 Cursor、Cherry Studio、Postman 等客户端。
返回新手上手，完成 Codex / CC Switch 的快速配置。

API 快速开始 ​

适用场景 ​

前置条件 ​

操作步骤 ​

成功验证 ​

常见失败 ​