文字轉圖像 API

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

POST/openapi/v1/text-to-image

建立文字轉圖像任務

此端點可讓您建立新的文字轉圖像任務。請參閱文字轉圖像任務物件，以查看文字轉圖像任務物件包含哪些屬性。

參數

Name
ai_model
Type
string
必选
Description
用於圖像生成的模型 ID。
可選值：
- nano-banana：標準模型（每張圖 3 點數）
- nano-banana-2：能力更強的均衡模型（每張圖 6 點數）
- nano-banana-pro：Pro 模型，品質更高（每張圖 9 點數）
- gpt-image-2：OpenAI GPT Image 2，高保真模型，僅支援有限的寬高比（每張圖 9 點數）
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：僅支援 1:1、3:2、2:3
可選值：
- 1:1：正方形
- 16:9：寬螢幕橫向（gpt-image-2 不支援）
- 9:16：寬螢幕直向（gpt-image-2 不支援）
- 4:3：標準橫向（gpt-image-2 不支援）
- 3:4：標準直向（gpt-image-2 不支援）
- 3:2：橫向（僅 gpt-image-2 支援）
- 2:3：直向（僅 gpt-image-2 支援）

回傳值

回應的 result 屬性包含新建立之文字轉圖像任務的 id。

失敗模式

Name
400 - Bad Request
Description
請求不合法。常見原因：
- 缺少參數：未提供必要參數（例如 ai_model、prompt）。
- 參數無效：ai_model 或 aspect_ratio 不在允許的取值範圍內。
- 參數衝突：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/text-to-image

# 从文本提示生成图像
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

取得文字轉圖像任務

此端點可讓您透過有效的任務 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

刪除文字轉圖像任務

此端點會永久刪除文字轉圖像任務，包含所有關聯的圖像和資料。此操作無法復原。

路徑參數

Name
id
Type
path
Description
要刪除的文字轉圖像任務的 ID。

回傳值

成功時回傳 200 OK。

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。

GET/openapi/v1/text-to-image

列出文字轉圖像任務

此端點可讓您取得文字轉圖像任務清單。

參數

Name
page_num
Type
integer
Description
分頁的頁碼。從 1 開始，預設為 1。
Name
page_size
Type
integer
Description
每頁大小限制。預設為 10 筆。最多允許 50 筆。
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

串流文字轉圖像任務

此端點使用伺服器傳送事件（SSE）為文字轉圖像任務串流傳輸即時更新。

參數

Name
id
Type
path
Description
要串流傳輸的文字轉圖像任務唯一識別碼。

回傳值

以伺服器傳送事件的形式回傳文字轉圖像任務物件串流。

對於 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

// 错误事件示例
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// 消息事件示例说明任务进度。
// 对于 PENDING 或 IN_PROGRESS 任务，响应流不会包含所有字段。
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=***"
  ]
}

文字轉圖像任務物件

文字轉圖像任務物件是 Meshy 用於追蹤從文字提示輸入生成圖像的工作單元。此物件具有以下屬性：

屬性

Name
id
Type
string
Description
任務的唯一識別碼。雖然我們使用 k-sortable UUID 作為任務 ID 的實作細節，但您不應對 ID 的格式做任何假設。
Name
type
Type
string
Description
圖像生成任務的類型。對於文字轉圖像任務，始終為 text-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 日星期五下午 12:00:00 GMT 表示為 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 物件參考請查看錯誤處理。
Name
consumed_credits
Type
integer
Description
該任務消耗的積分數。當任務狀態為 PENDING、IN_PROGRESS 或 SUCCEEDED 時返回。對於 FAILED 任務返回 0（失敗時積分會被退還）。

文本转图像任务对象示例

{
  "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
}