文件

非同步圖片生成 API 參考

適用於耗時較長的繪圖模型:先提交任務取得 task_id,再輪詢查詢結果。請求體與同步圖片介面一致(JSON 或 multipart/form-data)。

欄位
Base URLhttps://token.easyapi.com/v1
認證Authorization: Bearer `API_KEY`
示例模型dall-e-3
格式REST JSON(非同步任務)
計費按量計費
注意: 任務狀態:NOT_START(已建立)、IN_PROGRESS(生成中)、SUCCESS(完成,images 含圖片結果)、FAILURE(失敗,見 fail_reason)。建議每隔約 2 秒輪詢,直至離開 NOT_START / IN_PROGRESS。

示例模型

下文均以 dall-e-3(DALL·E 3)為例;更換其他模型時,請替換 model 參數,並參考控制台模型說明調整 size、quality 等欄位。

建立任務

POSThttps://token.easyapi.com/v1/images/tasks

提交非同步圖片生成任務,立即返回 task_id 與初始狀態。請求體欄位與同步端點(文生圖 / 圖生圖)完全一致,支援 application/json 或 multipart/form-data。

請求參數

名稱位置類型必選說明
AuthorizationheaderstringEasyAPI API Key。格式:Bearer `API_KEY`
Content-Typeheaderstringapplication/json 或 multipart/form-data

請求體

名稱類型必選說明
modelstring圖像模型 ID,與同步介面相同
promptstring圖像文本描述
ninteger生成張數,預設 1
sizestring輸出尺寸,需與模型支援範圍一致
response_formatstringurl 或 b64_json(依模型支援)
imagefile圖生圖時上傳的參考圖(multipart/form-data)

示例

{
  "model": "dall-e-3",
  "prompt": "一只金毛犬在阳光明媚的海滩上奔跑,水彩插画风格,柔和光线",
  "n": 1,
  "size": "1024x1024"
}

返回示例

{
  "code": "success",
  "data": {
    "task_id": "task_img_7c2f9a1b3e4d5c6a8b9f0e1d2c3a4b5",
    "status": "NOT_START",
    "action": "IMAGE_GENERATION",
    "quota": 2000
  }
}

查詢任務

GEThttps://token.easyapi.com/v1/images/tasks/{task_id}

示例請求: https://token.easyapi.com/v1/images/tasks/task_img_7c2f9a1b3e4d5c6a8b9f0e1d2c3a4b5

依 task_id 查詢任務狀態。status 為 SUCCESS 時,data.images 為標準 OpenAI Image Response 陣列(含 url / b64_json / revised_prompt)。

請求參數

名稱位置類型必選說明
AuthorizationheaderstringEasyAPI API Key。格式:Bearer `API_KEY`
task_idstring建立任務時返回的 task_id

返回示例

{
  "code": "success",
  "data": {
    "task_id": "task_img_7c2f9a1b3e4d5c6a8b9f0e1d2c3a4b5",
    "status": "SUCCESS",
    "images": [
      {
        "url": "https://cdn.example.com/images/img_dalle3_7c2f9a1b.png",
        "b64_json": "",
        "revised_prompt": "A golden retriever running on a sunny beach, watercolor illustration style"
      }
    ]
  }
}