公共参数

更新时间:
复制为 MD 格式

本页列出所有 Aidge API 共享的请求参数和响应字段。

公共请求参数

URL 查询参数

以下参数在每次 API 调用时必须拼入请求 URL。

参数

类型

是否必填

说明

partner_id

String

固定值:aidge

sign_method

String

固定值:sha256

sign_ver

String

固定值:v2

app_key

String

API Key 名称。

timestamp

String

当前时间的毫秒级时间戳。

sign

String

HMAC-SHA256 签名。详见鉴权方式

公共请求头

请求头

类型

是否必填

说明

Content-Type

String

固定值:application/json

x-iop-trial

String

设为 true 使用试用额度,默认 false

公共响应字段

所有 API 响应包含以下顶层字段:

字段

类型

说明

Code

String

业务响应码。"Success" 代表成功,其他值为命名错误码(如 InvalidParameterFreeQuotaExhausted)。详见错误码

Message

String

错误描述信息。成功时为 "ok" 或空。

RequestId

String

唯一请求标识。提交工单时请提供此值。

Success

Boolean

请求是否成功。与 Code == "Success" 等价。

Data

Object

API 特定返回数据。请求失败时为 null。可能包含 UsageMap 副字段记录调用用量。

异步任务字段

所有异步 API(包含文档翻译、视频翻译、视频消除、智能出图、尺码图提取、商品素材优化 Lite / Pro)的提交接口都会在响应的 Data 字段中返回以下任务跟踪字段:

字段

类型

说明

Data.TaskId

String

唯一任务标识,用于查询任务状态。

Data.Status

String

任务状态:QUEUED(排队中)、IN_PROGRESS(执行中)、COMPLETED(已完成)、FAILED(失败)。所有异步 SKU 经统一 QueryAsyncTaskResult 接口轮询,均使用本字段。:视频翻译 / 视频消除(一期暂缓)沿用旧版 Data.TaskStatus + submitted / running / finished / failed,详见各自文档。