跳到主要内容

AntAPI 简介

AntAPI 通过统一的 Gateway 提供自营 API。应用使用项目 API 密钥调用已发布的产品,付费操作从组织的共享 Credits 余额中扣费。

选择产品​

每个产品都有自己的 URL 前缀、请求格式、响应字段和成功结果定义。从文档首页选择已发布的产品。接入指南解释使用流程,API 参考则列出正式发布的端点、Schema 与当前价格。

通用请求路径为:

<gateway-base-url>/<product-slug>/v1/<endpoint-path>

官方 Gateway 地址为 https://api.antapi.dev,与公开网站和控制台的地址不同。所有产品请求,包括免费操作,都通过此入口调用。

组织接入资源​

概念用途
Organization(组织)持有共享 Credits 余额和项目。
Project(项目)管理 API 密钥和用量,并设置 UTC 月度预算。
API key(API 密钥)为项目中的产品请求认证,必须保存在服务端。
Credits根据正式发布的计费单位支付 API 操作费用。
Receipt(凭证)记录权威的最终付费结算结果。

在控制台中管理组织、项目、密钥、Credits 与用量。控制台使用会话 Cookie,后端调用产品 API 时使用项目 API 密钥。阅读公开文档无需登录。

理解两种执行方式​

同步操作直接在响应中返回结果。根据参考文档,付费端点可按成功请求或可信的成功处理项计费。

异步操作先返回受理响应,通常包含任务标识。随后通过产品端点读取进度与结果。HTTP 202 只确认受理,最终成功数量与费用在稍后确定。

执行付费操作前,平台先预留最高授权费用;确认执行结果后,按成功数量结算并释放未使用的预留。共享规则见 Credits 与计费,成功结果的定义见对应产品指南。

开始构建​

先完成快速开始,再阅读认证、安全重试与错误恢复,为生产接入做好准备。