统一任务 API
图片、视频模型共用一个 /v1/tasks 端点。提交即返回 taskId,支持轮询和回调两种方式取结果。
安全可靠
所有请求通过 HTTPS 加密传输。API Key 支持权限控制,可随时撤销。
全球加速
多区域分布式基础设施,全球低延迟访问。
快速开始
2
准备 HTTP 客户端
无需专用 SDK,任何能发起 HTTPS 请求的语言都可以直接调用。
# cURL 无需安装3
发起第一次 API 调用
提交一个图片生成任务,立即返回 taskId。将 YOUR_API_KEY 替换为你的实际密钥。
curl -X POST https://api.hiapi.ai/v1/tasks \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "gpt-image-2", "input": {"prompt": "a cute cat"}}'认证方式
所有 API 请求需要在 Authorization 请求头中以 Bearer Token 形式传递 API Key。
Authorization: Bearer YOUR_API_KEY请勿在客户端代码或公开仓库中暴露 API Key。请使用环境变量安全存储。
Base URL
所有 API 端点基于此 Base URL。
https://api.hiapi.ai/v1API 端点
创建任务
POST
/v1/tasks提交一个异步生成任务,立即返回 taskId,不等待生成完成。input 内的字段因模型而异,详见各模型页的 API 示例。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 必填 | 目标模型名称,如 gpt-image-2 |
| input | object | 必填 | 模型业务参数对象,字段因模型而异(如 prompt、resolution) |
| callback | object | 可选 | 终态回调配置(可选)。不传则自行轮询查询结果 |
代码示例
curl -X POST https://api.hiapi.ai/v1/tasks \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-image-2",
"input": {
"prompt": "a cute cat sitting on a windowsill"
}
}'查询任务
GET
/v1/tasks/:id用创建任务时返回的 taskId 查询状态与结果。status 为 queued / handling / archiving / success / fail;success 时返回 output 数组,其中的 url 可直接下载。
参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id | string | 必填 | 创建任务时返回的 taskId,以 tk-hiapi- 开头 |
代码示例
curl https://api.hiapi.ai/v1/tasks/tk-hiapi-01HZTQ8BX2N3GM3YFK4Z9D7VQR \
-H "Authorization: Bearer YOUR_API_KEY"错误处理
API 使用标准 HTTP 状态码。错误响应返回包含详细信息的 JSON 对象。
| 状态码 | 说明 |
|---|---|
| 400 | 请求错误 — 参数无效或缺少必填字段 |
| 401 | 未授权 — API Key 无效或缺失 |
| 402 | 余额不足 — 账户额度不足以支付本次任务预估费用,请充值后重试 |
| 403 | 禁止访问 — 权限不足或账户已暂停 |
| 429 | 请求过多 — 超出速率限制,请降低请求频率 |
| 500 | 服务器错误 — 服务端出现问题,请稍后重试 |
错误响应格式
{
"code": 400,
"message": "invalid request",
"data": null,
"error_code": "INVALID_REQUEST"
}