公共参数
本页列出所有 Aidge API 共享的请求参数和响应字段。
公共请求参数
URL 查询参数
以下参数在每次 API 调用时必须拼入请求 URL。
|
参数 |
类型 |
是否必填 |
说明 |
|
|
String |
是 |
固定值: |
|
|
String |
是 |
固定值: |
|
|
String |
是 |
固定值: |
|
|
String |
是 |
API Key 名称。 |
|
|
String |
是 |
当前时间的毫秒级时间戳。 |
|
|
String |
是 |
HMAC-SHA256 签名。详见鉴权方式。 |
公共请求头
|
请求头 |
类型 |
是否必填 |
说明 |
|
|
String |
是 |
固定值: |
|
|
String |
否 |
设为 |
公共响应字段
所有 API 响应包含以下顶层字段:
|
字段 |
类型 |
说明 |
|
|
String |
业务响应码。 |
|
|
String |
错误描述信息。成功时为 |
|
|
String |
唯一请求标识。提交工单时请提供此值。 |
|
|
Boolean |
请求是否成功。与 |
|
|
Object |
API 特定返回数据。请求失败时为 |
异步任务字段
所有异步 API(包含文档翻译、视频翻译、视频消除、智能出图、尺码图提取、商品素材优化 Lite / Pro)的提交接口都会在响应的 Data 字段中返回以下任务跟踪字段:
|
字段 |
类型 |
说明 |
|
|
String |
唯一任务标识,用于查询任务状态。 |
|
|
String |
任务状态: |