API 参考

上线前检查

生产流量上线前请完成这份检查清单,把密钥安全、重试、异步任务持久化、可观测性和计费统一纳入上线门禁。

#生产检查清单

安全

  • API Key 必须保存在可信服务端,绝不能放入浏览器代码或移动端安装包。
  • 每个项目使用独立的受限密钥,并配置模型、IP、RPM、RPD 和额度上限。
  • 无需修改模型接入代码即可轮换密钥。

可靠性

  • 为每个请求设置连接和响应超时。
  • 遵循 Retry-After,并使用带抖动的指数退避。
  • 会计费的异步提交必须使用 Idempotency-Key,并持久保存 task_id。

可观测性

  • 记录请求 ID、模型、接口、延迟、HTTP 状态和 task_id。
  • 除非明确开启调试,否则不要在日志中记录提示词内容。
  • 把客户看到的失败关联到对应的请求日志记录。

成本控制

  • 从实时模型元数据读取价格和支持选项。
  • 设置项目额度上限,并在钱包耗尽前告警。
  • 以请求日志中保留六位小数的最终消费进行对账。

#上线门禁

  1. 1

    测试最小请求

    在工作台运行准确的模型和接口,然后复制生成的请求。

  2. 2

    测试失败路径

    验证 401、402、429、超时、无效媒体和任务失败终态的处理。

  3. 3

    验证计费

    将成功请求与对应的六位小数消费和请求 ID 核对。

  4. 4

    启用监控

    针对错误率、延迟、卡住的任务、Webhook 失败和低余额设置告警。

#运营快捷入口

还是没解决?

把请求 ID 或报错信息发给我们,我们来查。