Skip to content

API Key

我们的 API 使用 Bearer 令牌对请求进行身份验证。你可以直接通过 curl 或 OpenAI SDK 与 AI Ping 交互。

1.1 管理 API Key

创建 API Key

  1. 在上方导航栏进入「个人中心」,并点击左侧「API 密钥」来到 API 密钥管理页面。

  2. 注册账号时,系统会默认为您创建一个 API Key。若需新增,在【API 管理】页面,点击右上角的「API KEY」按钮,打开创建弹窗。

  3. 填写基础信息:

    • API KEY 备注(选填,最多 50 字):建议填写清晰的业务标识,如「XX 项目 - 开发环境」「个人测试用」,方便后续管理和区分。
  4. 配置使用额度限制(必填):

  5. 选择额度类型,平台提供两种模式,您可按需选择:

额度类型规则说明适用场景
固定额度密钥累计消耗总额度达到设置金额后,Key 暂停使用;提升额度后可立即恢复正常使用;空白填写则无限制一次性项目、测试环境、短期合作场景
每月自动刷新每月 1 日 00:00 自动重置额度,当月消耗达上限后 Key 暂停使用;提升额度后可立即恢复正常使用,次月自动恢复长期稳定的业务场景、团队协作环境
  1. 确认配置无误后,点击「创建」按钮,即可生成您的 API Key。

  2. 请妥善保管密钥,避免泄露。您可以随时编辑、删除它。

1.2 修改额度

额度支持随时修改,修改后约 1 分钟生效,无需新建 Key。

修改额度的影响

操作效果
提升额度1 分钟后生效。若 Key 因额度用完不可用,提升后恢复可用
降低额度1 分钟后生效。若当前已消费金额超过新额度,Key 立即不可用
切换额度类型支持在三种类型间切换,切换后按新规则展示
取消额度限制(留空)1 分钟后生效。Key 可无限使用

1.3 Key 状态说明

状态说明恢复方式
正常额度未用完,Key 可正常使用
不可用已消费金额 ≥ 额度上限,暂时无法使用提升额度,1 分钟后恢复
禁用手动禁用或账号异常手动启用后恢复
已删除Key 已被删除,不可恢复需新建 Key

1.4 使用建议

  • 开发测试:建议使用「固定额度」并设置较低金额,避免意外超支。
  • 生产环境:建议使用「每月自动刷新」,配合合理的月度预算。

2. 使用 API Key

替换 <API_KEY> 为您的 API Key 即可

curl
curl -N -X POST https://aiping.cn/api/v1/chat/completions \
    -H "Authorization: Bearer <API_KEY>" \
    -H "Content-Type: application/json" \
    -d '{
        "model": "DeepSeek-R1-0528",
        "stream": true,
        "messages": [
            {
                "role": "user",
                "content": "Hello"
            }
        ],
        "extra_body": {
            "provider": {
                "only": [],
                "order": [],
                "sort": null,
                "input_price_range": [],
                "output_price_range": [],
                "input_length_range": [],
                "output_length_range": [],
                "throughput_range": [],
                "latency_range": []
            }
        }
    }'

2.1 关键说明与注意事项

2.1.1 额度相关规则

  • 额度修改后,需要等待 1 分钟 生效,修改期间不影响当前已生效的 Key 使用。
  • 固定额度 Key 消耗完后无法恢复,如需继续使用,需创建新的 API Key。
  • 每月自动刷新 额度的 Key,当月暂停后,无需手动操作,次月会自动恢复额度并启用。

2.1.2 安全与管理规范

  • API Key 是调用服务的核心凭证,请勿将密钥信息共享至公开环境,避免因未经授权的使用造成安全风险或资金损失。
  • 建议您为不同场景创建独立的 API Key,定期轮换密钥,降低泄露风险。
  • 若发现密钥泄露或异常使用,可在 API Key 列表中直接删除或修改限额,及时止损。

2.1.3 调用方式说明

  • 兼容 OpenAI 接口:使用 https://aiping.cn/api/v1 作为 Base URL,搭配您创建的 API Key,即可无缝对接 OpenAI 生态的工具、框架。
  • 兼容 Anthropic 接口:使用 https://aiping.cn/api/v1/anthropic 作为 Base URL,搭配 API Key 调用对应服务。