影像生成影像 API

影像生成影像 API 是一项功能，可让你将 Meshy 的 AI 图像编辑能力集成到你自己的应用程序中。使用参考图像和文本提示词，通过我们强大的 AI 模型来转换和编辑现有图像。

POST/openapi/v1/image-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，一款高保真图像编辑模型（每张图像 12 credits）
  • 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

    Authentication 失败。请检查您的 API key。

  • Name
    402 - Payment Required
    Description

    没有足够的 credits 来执行此任务。

  • 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

    此任务消耗的 credits 数量。当任务状态为 PENDING、IN_PROGRESS 或 SUCCEEDED 时会出现该字段。对于 FAILED 任务，返回 0（失败时 credits 会被退还）。

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
}