Text na obrázek API

Text na obrázek API je funkce, která vám umožňuje integrovat možnosti generování obrázků pomocí AI od Meshy do vlastní aplikace. Generujte vysoce kvalitní obrázky z textových promptů pomocí našich výkonných modelů AI.

POST/openapi/v1/text-to-image

Vytvoření úlohy Text na obrázek

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

Parametry

  • Name
    ai_model
    Type
    string
    Povinné
    Description

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

    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 s vylepšenou kvalitou (9 kreditů za obrázek)
    • gpt-image-2: OpenAI GPT Image 2, vysoce věrný model obrázků s omezenou podporou poměru stran (9 kreditů za obrázek)
  • Name
    prompt
    Type
    string
    Povinné
    Description

    Textový popis obrázku, který chcete vygenerovat. Pro nejlepší výsledky buďte popisní.

  • Name
    generate_multi_view
    Type
    boolean
    výchozí false
    Description

    Při nastavení na true vygeneruje obrázek s více pohledy, který zobrazuje objekt z více úhlů.

    Když je generate_multi_view true, parametr aspect_ratio nelze nastavit.

  • Name
    pose_mode
    Type
    string
    Description

    Zadejte pose mode pro generování postavy. Pokud je vynechán, obrázek se vygeneruje bez jakýchkoli přednastavení pózy.

    Dostupné hodnoty: a-pose, t-pose

  • Name
    aspect_ratio
    Type
    string
    výchozí 1:1
    Description

    Zadejte poměr stran vygenerovaného obrázku. Povolené hodnoty závisí na vybraném ai_model:

    • nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
    • gpt-image-2: pouze 1:1, 3:2, 2:3

    Dostupné hodnoty:

    • 1:1: Čtvercový formát
    • 16:9: Širokoúhlý formát na šířku (není podporováno gpt-image-2)
    • 9:16: Širokoúhlý formát na výšku (není podporováno gpt-image-2)
    • 4:3: Standardní formát na šířku (není podporováno gpt-image-2)
    • 3:4: Standardní formát na výšku (není podporováno gpt-image-2)
    • 3:2: Formát na šířku (podporováno pouze gpt-image-2)
    • 2:3: Formát na výšku (podporováno pouze gpt-image-2)

Vrací

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

Režimy selhání

  • Name
    400 - Bad Request
    Description

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

    • Chybějící parametr: Chybí povinný parametr (např. ai_model, prompt).
    • Neplatný parametr: ai_model nebo aspect_ratio není jednou z povolených hodnot.
    • Konflikt: generate_multi_view a aspect_ratio nelze použít současně.
  • 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/text-to-image
# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
GET/openapi/v1/text-to-image/:id

Získat úlohu Text na obrázek

Tento koncový bod vám umožňuje získat úlohu Text na obrázek podle platného id. Viz Objekt úlohy Text na obrázek, kde zjistíte, které vlastnosti jsou zahrnuty v objektu úlohy Text na obrázek.

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy Text na obrázek, kterou chcete získat.

Vrací

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

Request

GET
/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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/text-to-image/:id

Odstranění úlohy Text na obrázek

Tento koncový bod trvale odstraní úlohu Text 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 Text na obrázek, která se má odstranit.

Návratová hodnota

Při úspěchu vrací 200 OK.

Request

DELETE
/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.
GET/openapi/v1/text-to-image

Vypsat úlohy Text na obrázek

Tento koncový bod umožňuje načíst seznam úloh Text 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ě.

Vrací

Vrací stránkovaný seznam objektů úlohy Text na obrázek.

Request

GET
/openapi/v1/text-to-image
curl https://api.meshy.ai/openapi/v1/text-to-image?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "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/text-to-image/:id/stream

Streamování úlohy Text na obrázek

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

Parametry

  • Name
    id
    Type
    path
    Description

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

Návratová hodnota

Vrací stream objektů úlohy Text 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/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/text-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": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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 Text na obrázek

Objekt úlohy Text na obrázek je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování obrázku ze vstupu textový prompt. Objekt má následující vlastnosti:

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor úlohy. I když jako implementační detail používáme pro ID úloh k-sortovatelné UUID, neměli byste dělat žádné předpoklady o formátu ID.

  • Name
    type
    Type
    string
    Description

    Typ úlohy generování obrázku. U úloh Text na obrázek to bude vždy text-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 ke generování 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, tato vlastnost bude 0. Jakmile úloha uspěje, změní se na 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko vytvoření úlohy, 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 PM 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 spuštění úlohy, v milisekundách. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko dokončení úlohy, v milisekundách. Pokud úloha ještě není dokončena, tato vlastnost bude 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Časové razítko vypršení platnosti 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 stažitelných URL vygenerovaných obrázků. Když je povoleno generate_multi_view, toto pole obsahuje tři URL obrázků představující různé úhly pohledu. Jinak obsahuje jednu URL obrázku.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti chyby 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. U úloh FAILED vrací 0 (kredity jsou při selhání vráceny).

Example Text to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "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
}