Text till bild API

Text till bild API är en funktion som låter dig integrera Meshys AI-bildgenereringsmöjligheter i din egen applikation. Generera högkvalitativa bilder från textuppmaningar med våra kraftfulla AI-modeller.

POST/openapi/v1/text-to-image

Skapa en Text till bild-uppgift

Detta endpoint tillåter dig att skapa en ny Text till bild-uppgift. Se Text till bild-uppgiftsobjektet för att se vilka egenskaper som ingår i Text 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 högupplöst bildmodell (9 credits per bild)
  • Name
    prompt
    Type
    string
    Obligatorisk
    Description

    En textbeskrivning av bilden du vill generera. Var beskrivande för bästa resultat.

  • Name
    generate_multi_view
    Type
    boolean
    standard false
    Description

    När den är satt till true, genereras en flervybild som visar motivet från flera vinklar.

    När generate_multi_view är true, kan inte aspect_ratio-parametern ställas in.

  • Name
    pose_mode
    Type
    string
    Description

    Ange pose_mode för karaktärsgenerering. När den utelämnas genereras bilden utan några pose-förinställningar.

    Tillgängliga värden: a-pose, t-pose

  • Name
    aspect_ratio
    Type
    string
    standard 1:1
    Description

    Ange bildens bildförhållande. Tillåtna värden beror på den valda ai_model:

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

    Tillgängliga värden:

    • 1:1: Fyrkantigt format
    • 16:9: Widescreen landskap
    • 9:16: Widescreen porträtt
    • 4:3: Standard landskap (stöds inte av gpt-image-2)
    • 3:4: Standard porträtt (stöds inte av gpt-image-2)
    • 3:2: Landskap (endast stöds av gpt-image-2)
    • 2:3: Porträtt (endast stöds av gpt-image-2)
  • Name
    remove_background
    Type
    boolean
    standard false
    Description

    När den är satt till true, returneras den genererade bilden som en transparent RGBA PNG med bakgrunden borttagen, så att du kan komponera motivet på vilken bakgrund som helst.

Returnerar

result-egenskapen i svaret innehåller uppgiftens id för den nyligen skapade Text till bild-uppgiften.

Felmod

  • Name
    400 - Bad Request
    Description

    Begäran var oacceptabel. Vanliga orsaker:

    • Saknad parameter: En nödvändig parameter (t.ex. ai_model, prompt) saknas.
    • Ogiltig parameter: ai_model eller aspect_ratio är inte ett av de tillåtna värdena.
    • Konflikt: generate_multi_view och aspect_ratio kan inte användas samtidigt.
  • Name
    401 - Unauthorized
    Description

    Autentiseringen misslyckades. Kontrollera din API-nyckel.

  • Name
    402 - Payment Required
    Description

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

  • Name
    429 - Too Many Requests
    Description

    Du har överskridit din hastighetsgräns.

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

Hämta en Text till bild-uppgift

Detta endpoint tillåter dig att hämta en Text till bild-uppgift med ett giltigt uppgifts-id. Se Text till bild-uppgiftsobjektet för att se vilka egenskaper som ingår i Text till bild-uppgiftsobjektet.

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för Text till bild-uppgiften att hämta.

Returnerar

Svaret innehåller Text till bild-uppgiftsobjektet. Kontrollera Text till bild-uppgiftsobjektet sektionen för detaljer.

Förfrågan

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

Svar

{
  "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

Ta bort en Text till bild-uppgift

Detta endpoint tar permanent bort en Text till bild-uppgift, inklusive alla associerade bilder och data. Denna åtgärd är oåterkallelig.

Sökvägsparametrar

  • Name
    id
    Type
    path
    Description

    ID för den Text till bild-uppgift som ska tas bort.

Returnerar

Returnerar 200 OK vid framgång.

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

Lista Text till bild-uppgifter

Detta endpoint tillåter dig att hämta en lista över Text till bild-uppgifter.

Parametrar

  • Name
    page_num
    Type
    integer
    Description

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

  • Name
    page_size
    Type
    integer
    Description

    Sidstorleksgräns. Standard är 10 objekt. Max 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 av The Text to Image Task Objects.

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

Strömma en Text till bild-uppgift

Detta endpoint strömmar realtidsuppdateringar för en Text till bild-uppgift med hjälp av Server-Sent Events (SSE).

Parametrar

  • Name
    id
    Type
    path
    Description

    Unik identifierare för Text till bild-uppgiften att strömma.

Returnerar

Returnerar en ström av The Text to Image Task Objects som Server-Sent Events.

För PENDING eller IN_PROGRESS uppgifter, kommer svarströmmen endast att inkludera nödvändiga progress och status fält.

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

Objektet Text till bild-uppgift

Objektet Text till bild-uppgift är en arbetsenhet som Meshy håller reda på för att generera en bild från en text prompt-inmatning. Objektet har följande egenskaper:

Egenskaper

  • Name
    id
    Type
    string
    Description

    Unik identifierare för uppgiften. Även om vi använder ett k-sorterbart UUID för uppgifts-id som implementeringsdetalj, bör du inte göra några antaganden om formatet på id.

  • Name
    type
    Type
    string
    Description

    Typen av bildgenereringsuppgift. För Text till bild-uppgifter kommer detta alltid att vara text-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

    Text prompt som användes för att generera bilden.

  • Name
    status
    Type
    string
    Description

    Status för uppgiften. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Framsteg för uppgiften. Om uppgiften inte har startat ä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 RFC 3339-standarden. Till exempel representeras fredag den 1 september 2023 kl. 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 startat ännu kommer denna egenskap att vara 0.

  • Name
    finished_at
    Type
    timestamp
    Description

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

  • Name
    expires_at
    Type
    timestamp
    Description

    Tidsstämpel för när uppgiftsresultatet upphör, i millisekunder.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Antalet föregående uppgifter.

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

  • Name
    image_urls
    Type
    array
    Description

    En array av 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 visningsvinklar. Annars innehåller den en enda bild-URL.

  • Name
    task_error
    Type
    object
    Description

    Felformationer för misslyckade uppgifter. Se Fel för fullständig referens till task_error-objektet.

  • Name
    consumed_credits
    Type
    integer
    Description

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

Exempel på Text till bild-uppgiftsobjekt

{
  "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
}