Bild till bild-API

Redigera och omvandla bilder i din egen applikation. Skicka referensbilder och en text-prompt, så genererar Meshys AI-modeller en ny bild utifrån dem.

Bild till bild skapar bilder. Om du vill skapa en 3D-modell av det som finns i en bild, använd Bild till 3D. Om du vill skapa ett föremål du kan hålla i handen eller skriva ut från ett foto, använd Creative Lab-API:erna. De skapar en prototypbild och bygger sedan en 3D-modell utifrån den, till exempel en nyckelring, kylskåpsmagnet, figur, lampa eller keycap.

POST/openapi/v1/image-to-image

Skapa en Bild till bild-uppgift

Skapar en Bild till bild-uppgift. Uppgiften körs i bakgrunden. För information om hur lång tid en uppgift vanligtvis tar, se Processing times.

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


 ## Chaining from a previous task, instead of passing image URLs
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",
    "input_task_id": "<your Text to Image or Image to Image task id>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

Parametrar

Name
ai_model
Type
string
Obligatorisk
Description
AI-modellen som genererar bilden. Priserna skiljer sig mellan modeller. Se Priser.
Tillgängliga värden:
- nano-banana: standardmodellen
- nano-banana-2: mer kapabel än nano-banana
- nano-banana-2-lite: en lättare version av nano-banana-2
- nano-banana-2-1: Nano Banana 2.1
- nano-banana-pro: Pro-modellen, med högre kvalitet. Den kräver ett Pro-abonnemang eller högre. Vid ett lägre abonnemang returneras 402.
- gpt-image-2: OpenAI GPT Image 2
- gpt-image-2-5-flare: OpenAI GPT Image 2.5 (Flare)
- gpt-image-2-5-sunburst: OpenAI GPT Image 2.5 (Sunburst)
Name
prompt
Type
string
Obligatorisk
Description
Text som beskriver redigeringen eller transformationen som ska tillämpas på referensbilderna.

Name
input_task_id
Type
string
Obligatorisk
Description
Krävs om du inte skickar reference_image_urls. ID:t för en Text till bild- eller Bild till bild-uppgift vars bilder ska användas som referenser, inklusive flervy-uppgifter. Uppgiften måste vara en du skapade med API:et och ha statusen SUCCEEDED.
Meshy använder alla bilder som uppgiften producerade. En uppgift med en enda bild ger en referensbild, och en flervy-uppgift ger en per vy. Så ett enda uppgifts-ID kan fylla flera av de fem referensplatserna.
Uppgiften måste fortfarande vara inom tillgångslagringsperioden. Efter att den har gått ut returnerar dess ID 404.

Name
reference_image_urls
Type
array
Obligatorisk
Description
Krävs om du inte skickar input_task_id. En till fem referensbilder att redigera, var och en en offentlig URL eller en Data URI, till exempel data:image/jpeg;base64,<your base64-encoded image data>. En tom array, eller fler än fem bilder, returnerar 400. Om du skickar båda använder Meshy input_task_id.
Varje bild måste vara en .jpg-, .jpeg-, .png- eller .webp-fil på högst 20 MB, och minst 32 pixlar på varje sida.

Name
generate_multi_view
Type
boolean
standard false
Description
Om en flervy-bild ska genereras som visar motivet från flera vinklar. När true, kan du inte skicka aspect_ratio. Att skicka båda returnerar 400.
Name
aspect_ratio
Type
string
standard 1:1
Description
Bildförhållandet för utdatabilden. Vilka värden du kan skicka beror på ai_model.
Tillgängliga värden:
- 1:1: kvadrat
- 16:9: bredbild liggande
- 9:16: bredbild stående
- 4:3: standard liggande
- 3:4: standard stående
- 3:2: liggande, endast GPT Image-modeller
- 2:3: stående, endast GPT Image-modeller
GPT Image-modellerna är gpt-image-2, gpt-image-2-5-flare och gpt-image-2-5-sunburst. Med en nano-banana-modell returnerar 3:2 och 2:3 400.
Name
remove_background
Type
boolean
standard false
Description
Om bakgrunden ska tas bort. När true returnerar Meshy utdatabilden som en transparent RGBA PNG, så att du kan placera motivet mot vilken bakgrund som helst.

Returnerar

Fältet result i svaret innehåller ID:t för den nya Bild till bild-uppgiften.

Felscenarier

Name
400 - Bad Request
Description
Begäran kan inte köras. Felmeddelandet anger vilket problem som hittades. Till exempel:
- Saknad parameter: En obligatorisk parameter, såsom ai_model eller prompt, saknas, eller varken reference_image_urls eller input_task_id skickades.
- Ogiltig input-uppgift: input_task_id pekar inte på en användbar uppgift. Den måste vara en SUCCEEDED Text till bild- eller Bild till bild-uppgift, flervy inkluderat, som fortfarande har bildutdata. Meshy avvisar en uppgift av en annan typ, en uppgift som inte har lyckats, och en uppgift vars bilder alla har gått ut.
- Ogiltigt bildformat: En eller flera referensbilder har inte ett format som stöds.
- Oåtkomlig URL: Meshy kan inte ladda ner en eller flera reference_image_urls-bilder.
- Bild för stor: En eller flera reference_image_urls-bilder är över 20 MB.
- Bild för liten: En eller flera reference_image_urls-bilder har en sida kortare än 32 pixlar.
- Ogiltig parameter: aspect_ratio är inte ett av värdena som den valda ai_model stöder.
- Konflikt: Begäran skickar aspect_ratio med generate_multi_view: true.
Åtgärda begäran och skicka den igen. Se Fel.
Name
401 - Unauthorized
Description
API-nyckeln saknas eller är ogiltig. Kontrollera Authorization-huvudet.
Name
402 - Payment Required
Description
Kontot kan inte köra denna uppgift. Till exempel:
- Gratisabonnemang: Att skapa en uppgift kräver ett betalt abonnemang. Uppgradera ditt abonnemang i dina prenumerationsinställningar, och försök sedan igen.
- Otillräckliga credits: Kontot har inte tillräckligt med credits för denna uppgift, eller kontot har nått en creditgräns.
- Abonnemang krävs: Begäran använder nano-banana-pro på ett abonnemang lägre än Pro.
Kontrollera ditt saldo av credits och abonnemang, och försök sedan igen.
Name
404 - Not Found
Description
input_task_id matchar ingen uppgift i ditt konto. En uppgift som inte finns och en uppgift som tillhör ett annat konto returnerar samma svar. Kontrollera ID:t.
Name
429 - Too Many Requests
Description
Du överskred din hastighetsgräns. Vänta och försök sedan igen. Se Rate limits.

GET/openapi/v1/image-to-image/:id

Hämta en Bild till bild-uppgift

Returnerar en Bild till bild-uppgift via dess ID.

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=***"
  ]
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID från skaparsvaret.

Returnerar

Objektet för Bild till bild-uppgiften.

DELETE/openapi/v1/image-to-image/:id

Ta bort en Bild till bild-uppgift

Tar bort en Bild till bild-uppgift permanent, inklusive dess bilder och data. Du kan inte ångra en borttagning.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

Sökvägsparametrar

Name
id
Type
path
Description
ID:t för uppgiften som ska tas bort.

Uppgiftsstatus

Att ta bort en PENDING-uppgift återbetalar de credits som användes när du skapade den.

En IN_PROGRESS-uppgift kan inte tas bort. Begäran returnerar 409 Conflict, och uppgiften fortsätter att köras. Meshy återbetalar inte en uppgift som har startat, så att ta bort den skulle kosta dig både credits och resultatet. Vänta tills den når SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.

Att ta bort en uppgift i en slutgiltig status (SUCCEEDED, FAILED eller CANCELED) återbetalar inte dess credits.

Returnerar

200 OK när uppgiften har tagits bort, eller 409 Conflict när uppgiften är IN_PROGRESS.

GET/openapi/v1/image-to-image

Lista Bild till bild-uppgifter

Returnerar en lista över dina Bild till bild- och Text till bild-uppgifter. Varje uppgifts type-fält anger vilken av de två det är.

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=***"
    ]
  }
]

Parametrar

Name
page_num
Type
integer
Description
Sidnumret som ska returneras. Börjar på och har som standardvärde 1.
Name
page_size
Type
integer
Description
Antalet uppgifter per sida, upp till 100. Standardvärdet är 10.
Name
sort_by
Type
string
Description
Sorteringsordningen.
Tillgängliga värden:
- +created_at: äldsta först
- -created_at: nyaste först

Returnerar

En paginerad lista med uppgiftsobjekt, i samma format som Bild till bild-uppgiftsobjektet.

GET/openapi/v1/image-to-image/:id/stream

Strömma en Bild till bild-uppgift

Strömmar uppdateringar för en Bild till bild-uppgift som Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
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=***"
  ]
}

Parametrar

Name
id
Type
path
Description
Uppgifts-ID från skapandesvaret.

Returnerar

En ström av Bild till bild-uppgiftsobjekt som Server-Sent Events.

Varje händelse innehåller hela uppgiftsobjektet, i samma format som Get-endpointen returnerar. Medan uppgiften är PENDING eller IN_PROGRESS har dess resultatfält ännu inga värden.

Objektet för Bild till bild-uppgift

Ett objekt för en Bild till bild-uppgift beskriver en bild som genererats från referensbilder och en textprompt. Det innehåller status, progress och bilderna när uppgiften lyckas.

Egenskaper

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,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": null,

  "consumed_credits": 3
}

Name
id
Type
string
Description
Uppgiftens ID. Behandla det som en opak sträng och förlita dig inte på dess format.
Name
type
Type
string
Description
Uppgiftstypen, alltid image-to-image.
Name
ai_model
Type
string
Description
Den AI-modell som uppgiften använde.
Tillgängliga värden:
- nano-banana
- nano-banana-2
- nano-banana-2-lite
- nano-banana-2-1
- nano-banana-pro
- gpt-image-2
- gpt-image-2-5-flare
- gpt-image-2-5-sunburst
Name
prompt
Type
string
Description
Textprompten som styrde redigeringen.
Name
status
Type
string
Description
Uppgiftens status, en av PENDING, IN_PROGRESS, SUCCEEDED, FAILED eller CANCELED.
Name
progress
Type
integer
Description
Hur mycket av uppgiften som är klar, i procent. Den är 0 tills uppgiften startar och 100 när den lyckas.
Name
created_at
Type
timestamp
Description
Tidpunkten då uppgiften skapades, i Unix-millisekunder.
Name
started_at
Type
timestamp
Description
Tidpunkten då uppgiften startade, i Unix-millisekunder. Saknas tills uppgiften startar.
Name
finished_at
Type
timestamp
Description
Tidpunkten då uppgiften avslutades, i Unix-millisekunder. Saknas tills uppgiften avslutas.
Name
expires_at
Type
timestamp
Description
Tidpunkten då uppgiftens resultat upphör att gälla, i Unix-millisekunder. Saknas tills uppgiften avslutas.
Name
preceding_tasks
Type
integer
Description
Antalet uppgifter före denna i kön. Värdet är endast relevant medan uppgiften är PENDING. Fältet utelämnas när värdet är 0.
Name
image_urls
Type
array
Description
Nedladdnings-URL:er för de genererade bilderna. Med generate_multi_view: true innehåller den en URL per vy, vanligtvis tre. Om Meshy inte kan separera varje vy returneras färre, och uppgiften lyckas ändå. Annars innehåller den en URL.
Name
task_error
Type
object
Description
Felinformationen när uppgiften misslyckas. Den är null om inte statusen är FAILED. Se Fel.
Name
consumed_credits
Type
integer
Description
Antalet credits som uppgiften använde. Finns när statusen är PENDING, IN_PROGRESS eller SUCCEEDED. Den är 0 för en FAILED-uppgift, eftersom Meshy återbetalar credits när en uppgift misslyckas.