编辑图像
OpenAI Images API 兼容的图像编辑接口。默认同步返回编辑后的图片结果;如需异步提交,在请求 URL 上携带 ?async=true,接口会返回图片任务 ID,可通过 /v1/tasks/{id} 查询结果。
Authorization
bearerAuth 使用 Authorization Bearer API Key 进行鉴权。
In: header
Query Parameters
是否异步提交。
falseRequest Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/images/edits?async=true" \ -F image="string" \ -F prompt="string"{
"created": 0,
"data": [
{
"url": "http://example.com",
"b64_json": "string",
"revised_prompt": "string"
}
]
}{
"error": {
"code": "string",
"message": "string",
"request_id": "string"
}
}Image Generation
OpenAI Images API 兼容的图像生成接口。默认同步返回图片结果;如需异步提交,在请求 URL 上携带 `?async=true`,接口会返回图片任务 ID,可通过 `/v1/tasks/{id}` 查询结果。
Async Task Status
仅适用于在 `/v1/images/generations?async=true` 或 `/v1/images/edits?async=true` 提交后返回的图片任务 ID。 建议客户端按固定间隔轮询该接口:当任务为 `succeeded` 且 `data.images` 非空时读取图片结果;当任务为 `failed` 时读取 `error` 字段并停止轮询。图片结果可能包含 `url` 或 `b64_json`,具体取决于模型、渠道能力和提交请求中的 `response_format`。