画像から画像 API

画像から画像 API は、Meshy の AI 画像編集機能をあなたのアプリケーションに統合するための機能です。強力なAIモデルを使用して、参照画像やテキストプロンプトを用いて既存の画像を変換および編集します。

POST/openapi/v1/image-to-image

画像から画像タスクを作成する

このエンドポイントを使用して、新しい画像から画像タスクを作成できます。画像から画像タスクオブジェクトに含まれるプロパティについては、画像から画像タスクオブジェクトを参照してください。

パラメータ

Name
ai_model
Type
string
必須
Description
画像生成に使用するモデルのID。
利用可能な値:
- nano-banana: 標準モデル（1画像あたり3クレジット）
- nano-banana-2: 標準よりも強力なバランスモデル（1画像あたり6クレジット）
- nano-banana-pro: 品質が向上したプロモデル（1画像あたり9クレジット）
- gpt-image-2: OpenAI GPT Image 2、高忠実度の画像編集モデル（1画像あたり12クレジット）
Name
prompt
Type
string
必須
Description
参照画像に適用したい変換や編集のテキスト説明。
Name
reference_image_urls
Type
array
必須
Description
画像編集タスクに使用する1から5つの参照画像の配列。現在、.jpg、.jpeg、および.png形式をサポートしています。
各画像を提供する方法は2つあります：
- 公開アクセス可能な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）が欠如しています。
- 無効な画像形式: 1つ以上の参照画像がサポートされていない形式です。
- 到達不能なURL: 1つ以上のreference_image_urlsがダウンロードできませんでした。
- 無効なパラメータ: aspect_ratioが選択したai_modelの許可されている値の1つではありません。
- 競合: 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

画像から画像タスクの取得

このエンドポイントを使用すると、有効なタスク 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

画像から画像タスクを削除する

このエンドポイントは、画像から画像タスクとその関連するすべての画像とデータを永久に削除します。この操作は元に戻せません。

パスパラメータ

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

画像から画像タスクの一覧

このエンドポイントを使用して、画像から画像タスクの一覧を取得できます。

パラメータ

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/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

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

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

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

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

プロパティ

Name
id
Type
string
Description
タスクの一意識別子です。タスクIDにはkソート可能なUUIDを使用していますが、IDの形式については何も仮定しないでください。
Name
type
Type
string
Description
画像生成タスクのタイプです。画像から画像タスクの場合、常に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
画像変換を導くために使用されたテキストプロンプトです。
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 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
}