テキストから画像 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: 品質が向上したプロモデル（画像あたり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, 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）が欠落しています。
- 無効なパラメータ: 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

# 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

テキストから画像タスクの取得

このエンドポイントを使用すると、有効なタスク id を指定してテキストから画像タスクを取得できます。テキストから画像タスクオブジェクトに含まれるプロパティについては、テキストから画像タスクオブジェクトを参照してください。

パラメータ

Name
id
Type
path
Description
取得するテキストから画像タスクの一意の識別子。

戻り値

レスポンスにはテキストから画像タスクオブジェクトが含まれます。詳細はテキストから画像タスクオブジェクトセクションを確認してください。

リクエスト

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

レスポンス

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

// Returns 200 Ok on success.

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

テキストから画像タスクをストリームする

このエンドポイントは、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=***"
  ]
}

テキストから画像タスクオブジェクト

テキストから画像タスクオブジェクトは、Meshyがテキストプロンプト入力から画像を生成するために追跡する作業単位です。このオブジェクトには以下のプロパティがあります。

プロパティ

Name
id
Type
string
Description
タスクの一意の識別子です。タスクIDにはkソート可能なUUIDを使用していますが、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
画像を生成するために使用されたテキストプロンプトです。
Name
status
Type
string
Description
タスクのステータスです。可能な値はPENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
Name
progress
Type
integer
Description
タスクの進捗状況です。タスクがまだ開始されていない場合、このプロパティは0になります。タスクが成功した場合、これは100になります。
Name
created_at
Type
timestamp
Description
タスクが作成された時のタイムスタンプ（ミリ秒単位）です。
タイムスタンプは、1970年1月1日UTCから経過したミリ秒数を表し、RFC 3339標準に従います。例えば、2023年9月1日金曜日12:00:00 PM 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が有効な場合、この配列には異なる視点を表す3つの画像URLが含まれます。それ以外の場合、単一の画像URLが含まれます。
Name
task_error
Type
object
Description
失敗したタスクのエラー詳細です。完全なtask_errorオブジェクトの参照については、エラーを参照してください。
Name
consumed_credits
Type
integer
Description
このタスクで消費されたクレジットの数です。タスクのステータスが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
}