文字生成影像 API

文字生成影像 API 是一項功能，可讓您將 Meshy 的 AI 影像生成能力整合到您自己的應用程式中。使用我們強大的 AI 模型，根據文字提示生成高品質影像。

POST/openapi/v1/text-to-image

建立文字生成影像任務

此 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，一款高保真影像模型（每張影像 9 credits）
- gpt-image-2-5-flare：OpenAI GPT Image 2.5（Flare），一款高保真影像模型（每張影像 9 credits）
- gpt-image-2-5-sunburst：OpenAI GPT Image 2.5（Sunburst），一款高保真影像模型（每張影像 9 credits）
Name
prompt
Type
string
必選
Description
您希望生成的影像的文字描述。描述越詳細，效果越好。
Name
generate_multi_view
Type
boolean
預設值 false
Description
設為 true 時，將生成一張展示主體多個角度的多視圖影像。
當 generate_multi_view 為 true 時，無法設定 aspect_ratio 參數。
Name
pose_mode
Type
string
Description
指定角色生成的姿勢模式。若省略此參數，則生成的影像不帶任何姿勢預設。
可用值：a-pose、t-pose
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）。
- 參數無效：ai_model 或 aspect_ratio 不是允許的值之一。
- 衝突：generate_multi_view 與 aspect_ratio 不能同時使用。
Name
401 - Unauthorized
Description
身分驗證失敗。請檢查您的 API key。
Name
402 - Payment Required
Description
credits 不足，無法執行此任務。
Name
429 - Too Many Requests
Description
您已超出速率限制。

Request

POST

/openapi/v1/text-to-image

# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

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

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

取得文字生成影像任務

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

參數

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

回傳值

回應中包含文字生成影像任務物件。詳情請查看文字生成影像任務物件部分。

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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/text-to-image/:id

刪除文字生成影像任務

此 endpoint 會永久刪除一個文字生成影像任務，包括所有關聯的圖像和資料。此操作不可撤銷。

路徑參數

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

任務狀態

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

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

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

回傳值

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

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/text-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/text-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/text-to-image

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "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/text-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/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/text-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": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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=***"
  ]
}

Text to Image 任務物件

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

屬性

Name
id
Type
string
Description
任務的唯一識別碼。雖然我們在實作細節上使用 k-sortable UUID 作為任務 id，但你不應該對 id 的格式做任何假設。
Name
type
Type
string
Description
圖像生成任務的類型。對於 Text to Image 任務，此值始終為 text-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
任務建立時的時間戳，單位為毫秒。
時間戳表示自 1970 年 1 月 1 日 UTC 起經過的毫秒數，遵循 RFC 3339 標準。例如，2023 年 9 月 1 日星期五 GMT 時間 12:00:00 PM 表示為 1693569600000。這適用於 Meshy API 中的所有時間戳。
Name
started_at
Type
timestamp
Description
任務開始時的時間戳，單位為毫秒。如果任務尚未開始，此屬性值為 0。
Name
finished_at
Type
timestamp
Description
任務完成時的時間戳，單位為毫秒。如果任務尚未完成，此屬性值為 0。
Name
expires_at
Type
timestamp
Description
任務結果過期時的 expires_at，單位為毫秒。
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 物件參考請參見錯誤。
Name
consumed_credits
Type
integer
Description
此任務消耗的 consumed_credits 數量。當任務狀態為 PENDING、IN_PROGRESS 或 SUCCEEDED 時會出現該欄位。對於 FAILED 任務回傳 0（失敗時積分會被退還）。

Example Text to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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
}