影像生成影像 API

影像生成影像 API 是一項功能，可讓你將 Meshy 的 AI 圖像編輯能力整合到你自己的應用程式中。使用參考圖像和文字提示，借助我們強大的 AI 模型來轉換和編輯現有圖像。

POST/openapi/v1/image-to-image

Create an Image to Image Task

此 endpoint 允許你建立一個新的影象生成影象任務。請參閱影象生成影象任務物件以了解影象生成影象任務物件包含哪些屬性。

參數

Name
ai_model
Type
string
必選
Description
用於圖像生成的模型 ID。
可用值：
- nano-banana：標準模型（每張圖像 3 credits）
- nano-banana-2：均衡模型，能力強於標準模型（每張圖像 6 credits）
- nano-banana-pro：專業模型，品質更高（每張圖像 9 credits）
- gpt-image-2：OpenAI GPT Image 2，一款高保真圖像編輯模型（每張圖像 12 credits）
- gpt-image-2-5-flare：OpenAI GPT Image 2.5（Flare），一款高保真圖像編輯模型（每張圖像 12 credits）
- gpt-image-2-5-sunburst：OpenAI GPT Image 2.5（Sunburst），一款高保真圖像編輯模型（每張圖像 12 credits）
Name
prompt
Type
string
必選
Description
對你想套用於參考圖像的轉換或編輯的文字描述。

input_task_id 和 reference_image_urls 中只有一個是必需的。如果兩者都提供，則 input_task_id 具有更高優先順序。

Name
input_task_id
Type
string
必選
Description
一個已完成的圖像生成任務的 ID，其輸出圖像將被用作參考圖像。該任務必須是以下任務之一：文字生成影象或影象生成影象，包括它們的多視圖變體。此外，該任務必須是透過 API 執行的，且狀態為 SUCCEEDED。
來源任務的所有輸出圖像都會被使用。 單圖像任務貢獻 1 張參考圖像；多視圖任務則為每個生成的視圖貢獻一張，因此單一任務 ID 就可以填滿 5 個參考圖像位中的多個。
來源任務必須仍處於資產保留期內 —— 一旦過期，該任務 ID 將回傳 404。

Name
reference_image_urls
Type
array
必選
Description
一個包含 1 到 5 張參考圖像的陣列，用於圖像編輯任務。目前支援 .jpg、.jpeg 和 .png 格式。
提供每張圖像有兩種方式：
- 公開可存取的 URL：一個可從公共網際網路存取的 URL。
- Data URI：圖像的 base64 編碼 data URI。data URI 範例：data:image/jpeg;base64,<your base64-encoded image data>。

Name
generate_multi_view
Type
boolean
預設值 false
Description
設定為 true 時，將生成一張展示物件多個角度的多視圖圖像。
當 generate_multi_view 為 true 時，無法設定 aspect_ratio 參數。
Name
aspect_ratio
Type
string
預設值 1:1
Description
指定輸出圖像的寬高比。允許的值取決於所選的 ai_model：
- nano-banana、nano-banana-2、nano-banana-pro：1:1、16:9、9:16、4:3、3:4
- gpt-image-2、gpt-image-2-5-flare、gpt-image-2-5-sunburst：1:1、16:9、9:16、4:3、3:4、3:2、2:3
可用值：
- 1:1：正方形格式
- 16:9：寬螢幕橫向
- 9:16：寬螢幕縱向
- 4:3：標準橫向
- 3:4：標準縱向
- 3:2：橫向（僅 GPT Image 模型支援）
- 2:3：縱向（僅 GPT Image 模型支援）
Name
remove_background
Type
boolean
預設值 false
Description
設定為 true 時，輸出圖像將以去除背景的透明 RGBA PNG 形式回傳，方便你將主體合成到任意背景上。

回傳值

回應中的 result 屬性包含新建立的影象生成影象任務的任務 id。

失敗模式

Name
400 - Bad Request
Description
請求不可接受。常見原因：
- 缺少參數：缺少必需參數（例如 ai_model、prompt），或既未提供 reference_image_urls 也未提供 input_task_id。
- 無效的輸入任務：input_task_id 必須指向一個仍有圖像輸出、狀態為 SUCCEEDED 的文字生成影象或影象生成影象任務（包括多視圖任務）。任何其他類型的任務、未成功的任務，或圖像已全部過期的任務都會被拒絕。
- 無效的圖像格式：一張或多張參考圖像的格式不受支援。
- URL 無法連線：一個或多個 reference_image_urls 無法被下載。
- 無效參數：aspect_ratio 不是所選 ai_model 允許的值之一。
- 衝突：generate_multi_view 和 aspect_ratio 不能同時使用。
Name
401 - Unauthorized
Description
Authentication 失敗。請檢查你的 API key。
Name
402 - Payment Required
Description
credits 不足，無法執行此任務。
Name
404 - Not Found
Description
input_task_id 未指向你帳戶名下的任務。不存在的任務和屬於其他帳戶的任務會回傳相同的回應。
Name
429 - Too Many Requests
Description
你已超出速率限制。

Request

POST

/openapi/v1/image-to-image

# Transform a reference image with a text prompt
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>"
    ]
  }'


 ## Using Data URI example
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "data:image/png;base64,${YOUR_BASE64_ENCODED_IMAGE_DATA}"
    ]
  }'


 ## Chaining from a previous task, instead of passing image URLs
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "input_task_id": "<your Text to Image or Image to Image task id>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-image/:id

取得一個影像生成影像任務

此 endpoint 允許您透過一個有效的任務 id 取得一個影像生成影像任務。請參閱影像生成影像任務物件以查看影像生成影像任務物件包含哪些屬性。

參數

Name
id
Type
path
Description
要取得的影像生成影像任務的唯一識別碼。

回傳值

回應中包含影像生成影像任務物件。詳情請參閱影像生成影像任務物件部分。

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

DELETE/openapi/v1/image-to-image/:id

刪除影像生成影像任務

此 endpoint 將永久刪除一個影像生成影像任務，包括所有相關的圖片和資料。此操作不可復原。

路徑參數

Name
id
Type
path
Description
要刪除的影像生成影像任務的 ID。

任務狀態

仍處於 PENDING 狀態的任務將被刪除，並退還建立時消耗的 credits。

已處於 IN_PROGRESS 狀態的任務無法被刪除：請求會被拒絕並返回 409 Conflict，任務會繼續執行。工作處理程序已經開始處理的任務所消耗的 credits 是不可退還的，因此在執行過程中刪除該任務會導致 credits 和結果兩者都損失。請等待任務達到 SUCCEEDED、FAILED 或 CANCELED 狀態後再刪除。

處於終止狀態（SUCCEEDED、FAILED 或 CANCELED）的任務將被刪除，且不會退還 credits。

回傳值

成功時返回 200 OK，當任務處於 IN_PROGRESS 狀態時返回 409 Conflict。

Request

DELETE

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/image-to-image

取得影像轉影像任務清單

此 endpoint 允許您檢索影像轉影像任務清單。

參數

Name
page_num
Type
integer
Description
用於分頁的頁碼。起始值及預設值為 1。
Name
page_size
Type
integer
Description
每頁數量限制。預設為 10 項。最大允許值為 100 項。
Name
sort_by
Type
string
Description
用於排序的欄位。可用值：
- +created_at：按建立時間升冪排序。
- -created_at：按建立時間降冪排序。

回傳值

回傳一個分頁的影像轉影像任務物件清單。

Request

GET

/openapi/v1/image-to-image

curl https://api.meshy.ai/openapi/v1/image-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-image",
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1692771650657,
    "started_at": 1692771667037,
    "finished_at": 1692771669037,
    "expires_at": 1692771679037,
    "image_urls": [
      "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
    ]
  }
]

GET/openapi/v1/image-to-image/:id/stream

流式取得一個圖片生成圖片任務

此 endpoint 使用 Server-Sent Events（SSE）串流傳輸圖片生成圖片任務的即時更新。

參數

Name
id
Type
path
Description
要進行串流傳輸的圖片生成圖片任務的唯一識別碼。

回傳

以 Server-Sent Events 的形式回傳一個圖片生成圖片任務物件串流。

對於 PENDING 或 IN_PROGRESS 狀態的任務，回應串流中將僅包含必要的 progress 和 status 欄位。

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

Image to Image 任務物件

Image to Image 任務物件是 Meshy 用於追蹤任務的工作單元，用於根據參考圖像和文字 prompt 輸入生成圖像。該物件具有以下屬性：

屬性

Name
id
Type
string
Description
任務的唯一識別碼。雖然我們在實作細節上使用 k-sortable UUID 作為任務 id，但你不應該對 id 的格式做任何假設。
Name
type
Type
string
Description
圖像生成任務的類型。對於 Image to Image 任務，該值始終為 image-to-image。
Name
ai_model
Type
string
Description
該任務使用的 AI 模型。可能的值為 nano-banana、nano-banana-2、nano-banana-pro、gpt-image-2、gpt-image-2-5-flare 或 gpt-image-2-5-sunburst。
Name
prompt
Type
string
Description
用於指導圖像轉換的文字 prompt。
Name
status
Type
string
Description
任務的狀態。可能的值為 PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED 之一。
Name
progress
Type
integer
Description
任務的 progress。如果任務尚未開始，該屬性值為 0。一旦任務成功完成，該值將變為 100。
Name
created_at
Type
timestamp
Description
任務建立時間的 timestamp，單位為毫秒。
timestamp 表示自 1970 年 1 月 1 日 UTC 起經過的毫秒數，遵循 RFC 3339 標準。例如，2023 年 9 月 1 日星期五 GMT 時間中午 12:00:00 表示為 1693569600000。這適用於 Meshy API 中的所有 timestamp。
Name
started_at
Type
timestamp
Description
任務開始時間的 timestamp，單位為毫秒。如果任務尚未開始，該屬性值為 0。
Name
finished_at
Type
timestamp
Description
任務完成時間的 timestamp，單位為毫秒。如果任務尚未完成，該屬性值為 0。
Name
expires_at
Type
timestamp
Description
任務結果過期時間的 timestamp，單位為毫秒。
Name
preceding_tasks
Type
integer
Description
排在該任務前面的任務數量。
該欄位的值僅在任務狀態為 PENDING 時才有意義。
Name
image_urls
Type
array
Description
生成圖像的可下載 URL 陣列。啟用 generate_multi_view 時，該陣列包含代表不同視角的三個圖像 URL。否則，僅包含一個圖像 URL。
Name
task_error
Type
object
Description
失敗任務的錯誤詳情。完整的 task_error 物件參考請參見 Errors。
Name
consumed_credits
Type
integer
Description
該任務消耗的積分數量。當任務狀態為 PENDING、IN_PROGRESS 或 SUCCEEDED 時會顯示該欄位。對於 FAILED 任務，回傳 0（失敗時會退還積分）。

Example Image to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "preceding_tasks": 0,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3
}