影像生成影像 API

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

POST/openapi/v1/image-to-image

創建圖像生成圖像任務

此 endpoint 允許您創建一個新的圖像生成圖像任務。請參閱圖像生成圖像任務物件以了解圖像生成圖像任務物件包含哪些屬性。

參數

Name
ai_model
Type
string
必選
Description
用於圖像生成的模型 ID。
可用值：
- nano-banana：標準模型（每張圖像 3 積分）
- nano-banana-2：平衡模型，能力強於標準模型（每張圖像 6 積分）
- nano-banana-pro：專業模型，品質更佳（每張圖像 9 積分）
- gpt-image-2：OpenAI GPT Image 2，一款高保真圖像編輯模型（每張圖像 12 積分）
Name
prompt
Type
string
必選
Description
對您想要套用於參考圖像的轉換或編輯的文字描述。
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：1:1、16:9、9:16、3:2、2:3
可用值：
- 1:1：正方形格式
- 16:9：寬螢幕橫向
- 9:16：寬螢幕縱向
- 4:3：標準橫向（gpt-image-2 不支援）
- 3:4：標準縱向（gpt-image-2 不支援）
- 3:2：橫向（僅 gpt-image-2 支援）
- 2:3：縱向（僅 gpt-image-2 支援）
Name
remove_background
Type
boolean
預設值 false
Description
當設定為 true 時，輸出圖像將以去除背景的透明 RGBA PNG 格式回傳，以便您可以將主體合成到任何背景上。

返回值

回應中的 result 屬性包含新創建的圖像生成圖像任務的任務 id。

失敗模式

Name
400 - Bad Request
Description
請求不可接受。常見原因：
- 缺少參數：缺少必需的參數（例如 ai_model、prompt、reference_image_urls）。
- 圖像格式無效：一個或多個參考圖像的格式不受支援。
- URL 無法存取：一個或多個 reference_image_urls 無法下載。
- 參數無效：aspect_ratio 不是所選 ai_model 允許的值之一。
- 衝突：generate_multi_view 和 aspect_ratio 不能同時使用。
Name
401 - Unauthorized
Description
身份驗證失敗。請檢查您的 API 金鑰。
Name
402 - Payment Required
Description
沒有足夠的積分來執行此任務。
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}"
    ]
  }'

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。

回傳值

成功時回傳 200 OK。

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

// Returns 200 Ok on success.

GET/openapi/v1/image-to-image

列出影像生成影像任務

此 endpoint 允許你取得影像生成影像任務的清單。

參數

Name
page_num
Type
integer
Description
用於分頁的頁碼。起始值及預設值為 1。
Name
page_size
Type
integer
Description
每頁數量限制。預設值為 10 項，最多允許 50 項。
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 使用伺服器發送事件（SSE）串流傳輸影像生成影像任務的即時更新。

參數

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

回傳

以伺服器發送事件的形式回傳一個影像生成影像任務物件串流。

對於處於 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=***"
  ]
}

The Image to Image Task Object

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

Properties

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。
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
任務建立時的時間戳，單位為毫秒。
時間戳表示自 1970 年 1 月 1 日 UTC 以來經過的毫秒數，遵循 RFC 3339 標準。例如，2023 年 9 月 1 日星期五 GMT 時間中午 12:00:00 表示為 1693569600000。這適用於 Meshy API 中的所有時間戳。
Name
started_at
Type
timestamp
Description
任務開始時的時間戳，單位為毫秒。如果任務尚未開始，該屬性值為 0。
Name
finished_at
Type
timestamp
Description
任務完成時的時間戳，單位為毫秒。如果任務尚未完成，該屬性值為 0。
Name
expires_at
Type
timestamp
Description
任務結果過期時的時間戳，單位為毫秒。
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
}