Image to Image API

Ang Image to Image API ay isang feature na nagbibigay-daan sa iyong i-integrate ang mga kakayahan sa pag-edit ng larawan gamit ang AI ng Meshy sa sarili mong application. I-transform at i-edit ang mga umiiral na larawan gamit ang mga reference image at text prompt sa pamamagitan ng aming makapangyarihang mga AI model.

POST/openapi/v1/image-to-image

Gumawa ng Image to Image Task

Pinapayagan ka ng endpoint na ito na gumawa ng bagong Image to Image task. Sumangguni sa Ang Image to Image Task Object upang makita kung aling mga property ang kasama sa Image to Image task object.

Mga Parameter

Name
ai_model
Type
string
Kinakailangan
Description
ID ng model na gagamitin para sa image generation.
Mga available na value:
- nano-banana: Standard model (3 credits bawat image)
- nano-banana-2: Balanced model na may mas malakas na capability kaysa standard (6 credits bawat image)
- nano-banana-pro: Pro model na may pinahusay na quality (9 credits bawat image)
- gpt-image-2: OpenAI GPT Image 2, isang high-fidelity image edit model (12 credits bawat image)
Name
prompt
Type
string
Kinakailangan
Description
Isang text description ng transformation o edit na gusto mong i-apply sa mga reference image.
Name
reference_image_urls
Type
array
Kinakailangan
Description
Isang array ng 1 hanggang 5 reference image na gagamitin para sa image editing task. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan para ibigay ang bawat image:
- Publicly accessible URL: Isang URL na accessible mula sa public internet.
- Data URI: Isang base64-encoded Data URI ng image. Halimbawa ng isang Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
generate_multi_view
Type
boolean
default false
Description
Kapag naka-set sa true, bumubuo ng Multi-View image na nagpapakita sa subject mula sa maraming anggulo.

Mga Ibinabalik

Ang result property ng response ay naglalaman ng task id ng bagong ginawang Image to Image task.

Mga Failure Mode

Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:
- Nawawalang parameter: Nawawala ang isang kinakailangang parameter (hal., ai_model, prompt, reference_image_urls).
- Invalid na image format: Hindi supported format ang isa o higit pang reference image.
- Hindi maabot na URL: Hindi ma-download ang isa o higit pang reference_image_urls.
Name
401 - Unauthorized
Description
Hindi nagtagumpay ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits para isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.

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

Kunin ang isang Image to Image Task

Pinapayagan ka ng endpoint na ito na kunin ang isang Image to Image task gamit ang valid na task id. Sumangguni sa Image to Image Task Object upang makita kung aling mga property ang kasama sa Image to Image task object.

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Image to Image task na kukunin.

Ibinabalik

Naglalaman ang response ng Image to Image task object. Tingnan ang seksyong Image to Image Task Object para sa mga detalye.

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

Tanggalin ang isang Image to Image Task

Permanenteng tinatanggal ng endpoint na ito ang isang Image to Image task, kasama ang lahat ng kaugnay na larawan at data. Hindi na mababawi ang aksyong ito.

Mga Path Parameter

Name
id
Type
path
Description
Ang ID ng Image to Image task na tatanggalin.

Mga Ibinabalik

Ibinabalik ang 200 OK kapag matagumpay.

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

Ilista ang mga Image to Image Task

Pinapayagan ka ng endpoint na ito na kunin ang listahan ng mga Image to Image task.

Mga Parameter

Name
page_num
Type
integer
Description
Numero ng pahina para sa pagination. Nagsisimula at nagde-default sa 1.
Name
page_size
Type
integer
Description
Limitasyon ng laki ng pahina. Nagde-default sa 10 item. Ang pinakamataas na pinapayagan ay 50 item.
Name
sort_by
Type
string
Description
Field na gagamitin sa pag-uuri. Mga available na value:
- +created_at: Ayusin ayon sa oras ng paggawa sa pataas na pagkakasunod-sunod.
- -created_at: Ayusin ayon sa oras ng paggawa sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng naka-pagination na listahan ng Mga Image to Image Task Object.

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

I-stream ang isang Image to Image Task

Nag-i-stream ang endpoint na ito ng mga real-time na update para sa isang Image to Image task gamit ang Server-Sent Events (SSE).

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Image to Image task na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng Mga Image to Image Task Object bilang Server-Sent Events.

Para sa mga task na PENDING o IN_PROGRESS, isasama lamang ng response stream ang kinakailangang mga field na progress at 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=***"
  ]
}

Ang Image to Image Task Object

Ang Image to Image Task object ay isang yunit ng gawain na sinusubaybayan ng Meshy upang bumuo ng isang larawan mula sa input na mga reference image at isang text prompt. Ang object ay may mga sumusunod na property:

Mga Property

Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementation, huwag kang gumawa ng anumang palagay tungkol sa format ng id.
Name
type
Type
string
Description
Ang uri ng image generation task. Para sa mga Image to Image task, ito ay palaging magiging image-to-image.
Name
ai_model
Type
string
Description
Ang AI model na ginamit para sa task na ito. Ang mga posibleng value ay nano-banana, nano-banana-2, nano-banana-pro, o gpt-image-2.
Name
prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang pagbabago ng image.
Name
status
Type
string
Description
Katayuan ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress ng task. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0. Kapag nagtagumpay na ang task, magiging 100 ito.
Name
created_at
Type
timestamp
Description
timestamp kung kailan ginawa ang task, sa milliseconds.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula noong Enero 1, 1970 UTC, alinsunod sa pamantayang RFC 3339. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Nalalapat ito sa lahat ng timestamp sa Meshy API.
Name
started_at
Type
timestamp
Description
timestamp kung kailan nagsimula ang task, sa milliseconds. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0.
Name
finished_at
Type
timestamp
Description
timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa tapos ang task, ang property na ito ay magiging 0.
Name
expires_at
Type
timestamp
Description
timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Makabuluhan lamang ang value ng field na ito kung ang status ng task ay PENDING.
Name
image_urls
Type
array
Description
Isang array ng mga nada-download na URL papunta sa mga nabuong image. Kapag naka-enable ang generate_multi_view, naglalaman ang array na ito ng tatlong image URL na kumakatawan sa magkakaibang viewing angle. Kung hindi, naglalaman ito ng iisang image URL.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nakonsumo ng task na ito. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED task (ibinabalik ang credits kapag nabigo).

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
}