API för Bild till bild

API för Bild till bild är en funktion som låter dig integrera Meshys AI-bildredigeringsfunktioner i din egen applikation. Transformera och redigera befintliga bilder med hjälp av referensbilder och textprompter med våra kraftfulla AI-modeller.

POST/openapi/v1/image-to-image

Skapa en Bild till bild-uppgift

Denna endpoint låter dig skapa en ny Bild till bild-uppgift. Se Bild till bild-uppgiftsobjektet för att se vilka egenskaper som ingår i Bild till bild-uppgiftsobjektet.

Parametrar

  • Name
    ai_model
    Type
    string
    Obligatorisk
    Description

    ID för modellen som ska användas för bildgenerering.

    Tillgängliga värden:

    • nano-banana: Standardmodell (3 credits per bild)
    • nano-banana-2: Balanserad modell med starkare kapacitet än standard (6 credits per bild)
    • nano-banana-pro: Pro-modell med förbättrad kvalitet (9 credits per bild)
    • gpt-image-2: OpenAI GPT Image 2, en bildredigeringsmodell med hög detaljtrohet (12 credits per bild)
  • Name
    prompt
    Type
    string
    Obligatorisk
    Description

    En textbeskrivning av den transformation eller redigering du vill tillämpa på referensbilderna.

  • Name
    reference_image_urls
    Type
    array
    Obligatorisk
    Description

    En array med 1 till 5 referensbilder att använda för bildredigeringsuppgiften. Vi stöder för närvarande formaten .jpg, .jpeg och .png.

    Det finns två sätt att tillhandahålla varje bild:

    • Publikt tillgänglig URL: En URL som är tillgänglig från det publika internet.
    • Data URI: En base64-kodad Data URI för bilden. Exempel på en Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    generate_multi_view
    Type
    boolean
    standard false
    Description

    När detta är satt till true genereras en flervy-bild som visar motivet från flera vinklar.

Returnerar

Egenskapen result i svaret innehåller uppgiftens id för den nyskapade Bild till bild-uppgiften.

Fellägen

  • Name
    400 - Bad Request
    Description

    Begäran var oacceptabel. Vanliga orsaker:

    • Saknad parameter: En obligatorisk parameter (t.ex. ai_model, prompt, reference_image_urls) saknas.
    • Ogiltigt bildformat: En eller flera referensbilder är inte format som stöds.
    • Oåtkomlig URL: En eller flera reference_image_urls kunde inte laddas ned.
  • Name
    401 - Unauthorized
    Description

    Autentisering misslyckades. Kontrollera din API-nyckel.

  • Name
    402 - Payment Required
    Description

    Otillräckligt med credits för att utföra denna uppgift.

  • Name
    429 - Too Many Requests
    Description

    Du har överskridit din hastighetsgräns.

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

Hämta en Bild till bild-uppgift

Denna endpoint låter dig hämta en Bild till bild-uppgift med ett giltigt uppgifts-id. Se Objektet Bild till bild-uppgift för att se vilka egenskaper som ingår i ett uppgiftsobjekt för Bild till bild.

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för Bild till bild-uppgiften som ska hämtas.

Returnerar

Svaret innehåller uppgiftsobjektet för Bild till bild. Se avsnittet Objektet Bild till bild-uppgift för detaljer.

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

Ta bort en Bild till bild-uppgift

Denna endpoint tar permanent bort en Bild till bild-uppgift, inklusive alla associerade bilder och data. Denna åtgärd kan inte ångras.

Sökvägsparametrar

  • Name
    id
    Type
    path
    Description

    ID:t för Bild till bild-uppgiften som ska tas bort.

Returnerar

Returnerar 200 OK vid lyckat resultat.

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

Lista Bild till bild-uppgifter

Denna endpoint låter dig hämta en lista över Bild till bild-uppgifter.

Parametrar

  • Name
    page_num
    Type
    integer
    Description

    Sidnummer för paginering. Börjar och är som standard 1.

  • Name
    page_size
    Type
    integer
    Description

    Gräns för sidstorlek. Standard är 10 objekt. Maximalt tillåtet är 50 objekt.

  • Name
    sort_by
    Type
    string
    Description

    Fält att sortera efter. Tillgängliga värden:

    • +created_at: Sortera efter skapandetid i stigande ordning.
    • -created_at: Sortera efter skapandetid i fallande ordning.

Returnerar

Returnerar en paginerad lista över objekten för Bild till bild-uppgift.

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

Strömma en Bild till bild-uppgift

Denna endpoint strömmar realtidsuppdateringar för en Bild till bild-uppgift med Server-Sent Events (SSE).

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för Bild till bild-uppgiften som ska strömmas.

Returnerar

Returnerar en ström av Bild till bild-uppgiftsobjekten som Server-Sent Events.

För PENDING- eller IN_PROGRESS-uppgifter kommer svarsströmmen endast att inkludera nödvändiga fält för progress och 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=***"
  ]
}

Uppgiftsobjektet Bild till bild

Uppgiftsobjektet Bild till bild är en arbetsenhet som Meshy håller reda på för att generera en bild från indata bestående av referensbilder och en text-prompt. Objektet har följande egenskaper:

Egenskaper

  • Name
    id
    Type
    string
    Description

    Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id:n som en implementeringsdetalj, bör du inte göra några antaganden om id:ts format.

  • Name
    type
    Type
    string
    Description

    Typen av bildgenereringsuppgift. För Bild till bild-uppgifter kommer detta alltid att vara image-to-image.

  • Name
    ai_model
    Type
    string
    Description

    AI-modellen som används för denna uppgift. Möjliga värden är nano-banana, nano-banana-2, nano-banana-pro eller gpt-image-2.

  • Name
    prompt
    Type
    string
    Description

    Den textprompt som användes för att styra bildtransformeringen.

  • Name
    status
    Type
    string
    Description

    Uppgiftens status. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Uppgiftens progress. Om uppgiften inte har startats ännu kommer denna egenskap att vara 0. När uppgiften har lyckats blir detta 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften skapades, i millisekunder.

    En tidsstämpel representerar antalet millisekunder som har förflutit sedan 1 januari 1970 UTC, enligt standarden RFC 3339. Till exempel representeras fredag 1 september 2023 12:00:00 GMT som 1693569600000. Detta gäller för alla tidsstämplar i Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startats ännu kommer denna egenskap att vara 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiften slutfördes, i millisekunder. Om uppgiften inte är slutförd ännu kommer denna egenskap att vara 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Antalet föregående uppgifter.

    Värdet för detta fält är meningsfullt endast om uppgiftens status är PENDING.

  • Name
    image_urls
    Type
    array
    Description

    En array med nedladdningsbara URL:er till de genererade bilderna. När generate_multi_view är aktiverat innehåller denna array tre bild-URL:er som representerar olika betraktningsvinklar. Annars innehåller den en enda bild-URL.

  • Name
    task_error
    Type
    object
    Description

    Felinformation för misslyckade uppgifter. Se Fel för den fullständiga objektreferensen för task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Antalet credits som förbrukats av denna uppgift. Finns när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid fel).

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
}