API Obrázek na obrázek

API Obrázek na obrázek je funkce, která vám umožňuje integrovat možnosti úprav obrázků pomocí AI od Meshy do vaší vlastní aplikace. Transformujte a upravujte existující obrázky pomocí referenčních obrázků a textových promptů s našimi výkonnými modely AI.

POST/openapi/v1/image-to-image

Vytvoření úlohy Obrázek na obrázek

Tento koncový bod vám umožňuje vytvořit novou úlohu Obrázek na obrázek. Podívejte se na Objekt úlohy Obrázek na obrázek, kde zjistíte, které vlastnosti jsou zahrnuty v objektu úlohy Obrázek na obrázek.

Parametry

  • Name
    ai_model
    Type
    string
    Povinné
    Description

    ID modelu, který se má použít pro generování obrázků.

    Dostupné hodnoty:

    • nano-banana: Standardní model (3 kredity za obrázek)
    • nano-banana-2: Vyvážený model se silnějšími schopnostmi než standardní (6 kreditů za obrázek)
    • nano-banana-pro: Pro model se zvýšenou kvalitou (9 kreditů za obrázek)
    • gpt-image-2: OpenAI GPT Image 2, model pro úpravu obrázků s vysokou věrností (12 kreditů za obrázek)
  • Name
    prompt
    Type
    string
    Povinné
    Description

    Textový popis transformace nebo úpravy, kterou chcete použít na referenční obrázky.

  • Name
    reference_image_urls
    Type
    array
    Povinné
    Description

    Pole 1 až 5 referenčních obrázků, které se mají použít pro úlohu úpravy obrázku. Aktuálně podporujeme formáty .jpg, .jpeg a .png.

    Každý obrázek lze poskytnout dvěma způsoby:

    • Veřejně dostupná URL: URL, která je dostupná z veřejného internetu.
    • Data URI: Data URI obrázku kódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    generate_multi_view
    Type
    boolean
    výchozí false
    Description

    Když je nastaveno na true, vygeneruje obrázek s více pohledy zobrazující předmět z více úhlů.

Vrací

Vlastnost result v odpovědi obsahuje id úlohy nově vytvořené úlohy Obrázek na obrázek.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Požadavek byl nepřijatelný. Běžné příčiny:

    • Chybějící parametr: Chybí povinný parametr (např. ai_model, prompt, reference_image_urls).
    • Neplatný formát obrázku: Jeden nebo více referenčních obrázků není v podporovaném formátu.
    • Nedostupná URL: Jednu nebo více reference_image_urls se nepodařilo stáhnout.
  • Name
    401 - Unauthorized
    Description

    Autentizace selhala. Zkontrolujte prosím svůj API klíč.

  • Name
    402 - Payment Required
    Description

    Nedostatek kreditů k provedení této úlohy.

  • Name
    429 - Too Many Requests
    Description

    Překročili jste svůj limit rychlosti.

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

Načtení úlohy Obrázek na obrázek

Tento koncový bod vám umožňuje načíst úlohu Obrázek na obrázek se zadaným platným id úlohy. V části Objekt úlohy Obrázek na obrázek najdete, které vlastnosti jsou zahrnuty v objektu úlohy Obrázek na obrázek.

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy Obrázek na obrázek, kterou chcete načíst.

Vrací

Odpověď obsahuje objekt úlohy Obrázek na obrázek. Podrobnosti najdete v části Objekt úlohy Obrázek na obrázek.

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

Odstranění úlohy Obrázek na obrázek

Tento koncový bod trvale odstraní úlohu Obrázek na obrázek, včetně všech souvisejících obrázků a dat. Tato akce je nevratná.

Parametry cesty

  • Name
    id
    Type
    path
    Description

    ID úlohy Obrázek na obrázek, která se má odstranit.

Návratová hodnota

Při úspěchu vrací 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

Seznam úloh Obrázek na obrázek

Tento koncový bod vám umožňuje načíst seznam úloh Obrázek na obrázek.

Parametry

  • Name
    page_num
    Type
    integer
    Description

    Číslo stránky pro stránkování. Začíná na 1 a výchozí hodnota je 1.

  • Name
    page_size
    Type
    integer
    Description

    Limit velikosti stránky. Výchozí hodnota je 10 položek. Maximální povolená hodnota je 50 položek.

  • Name
    sort_by
    Type
    string
    Description

    Pole, podle kterého se má řadit. Dostupné hodnoty:

    • +created_at: Řadit podle času vytvoření vzestupně.
    • -created_at: Řadit podle času vytvoření sestupně.

Návratové hodnoty

Vrací stránkovaný seznam objektů úloh Obrázek na obrázek.

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

Streamovat úlohu Obrázek na obrázek

Tento koncový bod streamuje aktualizace v reálném čase pro úlohu Obrázek na obrázek pomocí Server-Sent Events (SSE).

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy Obrázek na obrázek, která se má streamovat.

Vrací

Vrací stream objektů úlohy Obrázek na obrázek jako Server-Sent Events.

U úloh PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a 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=***"
  ]
}

Objekt úlohy Obrázek na obrázek

Objekt úlohy Obrázek na obrázek je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování obrázku ze vstupu referenčních obrázků a textového promptu. Objekt má následující vlastnosti:

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor úlohy. Ačkoli jako implementační detail používáme k-sortable UUID pro ID úloh, neměli byste činit žádné předpoklady o formátu id.

  • Name
    type
    Type
    string
    Description

    Typ úlohy generování obrázku. U úloh Obrázek na obrázek to bude vždy image-to-image.

  • Name
    ai_model
    Type
    string
    Description

    Model AI použitý pro tuto úlohu. Možné hodnoty jsou nano-banana, nano-banana-2, nano-banana-pro nebo gpt-image-2.

  • Name
    prompt
    Type
    string
    Description

    Textový prompt, který byl použit k vedení transformace obrázku.

  • Name
    status
    Type
    string
    Description

    Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress úlohy. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0. Jakmile úloha úspěšně skončí, změní se na 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha vytvořena, v milisekundách.

    Časové razítko představuje počet milisekund uplynulých od 1. ledna 1970 UTC podle standardu RFC 3339. Například pátek 1. září 2023 12:00:00 GMT je reprezentován jako 1693569600000. To platí pro všechna časová razítka v Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, bude tato vlastnost 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy vyprší platnost výsledku úlohy, v milisekundách.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Počet předcházejících úloh.

    Hodnota tohoto pole má význam pouze tehdy, pokud je stav úlohy PENDING.

  • Name
    image_urls
    Type
    array
    Description

    Pole adres URL ke stažení pro vygenerované obrázky. Když je povoleno generate_multi_view, toto pole obsahuje tři adresy URL obrázků představující různé pozorovací úhly. Jinak obsahuje jednu adresu URL obrázku.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti o chybě pro neúspěšné úlohy. Úplnou referenci objektu task_error najdete v části Chyby.

  • Name
    consumed_credits
    Type
    integer
    Description

    Počet kreditů spotřebovaných touto úlohou. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úlohy FAILED (kredity jsou při selhání vráceny).

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
}