Text till bild-API

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

Denna endpoint producerar bilder. Om målet är ett objekt du kan hålla i handen eller skriva ut — en nyckelring, kylskåpsmagnet, figur, lampa eller keycap från ett foto — använd Creative Lab-API:erna (prototypbild → bygg 3D-modell). Om målet är en 3D-modell av det som finns på bilden, använd Bild till 3D.

POST/openapi/v1/text-to-image

Skapa en uppgift för Text till bild

Denna endpoint låter dig skapa en ny uppgift för Text till bild. Se The Text to Image Task Object för att se vilka egenskaper som ingår i Text till bild-uppgiftsobjektet.

Uppgiften körs i bakgrunden. För information om hur lång tid det vanligtvis tar, se Processing Times.

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-2-lite: Lätt variant av nano-banana-2 (3 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)
- gpt-image-2-5-flare: OpenAI GPT Image 2.5 (Flare), en högupplöst bildmodell (9 credits per bild)
- gpt-image-2-5-sunburst: OpenAI GPT Image 2.5 (Sunburst), 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 detta är satt till true genereras en flervybild som visar motivet från flera vinklar.
När generate_multi_view är true kan parametern aspect_ratio inte anges.
Name
pose_mode
Type
string
Description
Ange pose-mode för karaktärsgenerering. Om parametern utelämnas genereras bilden utan några förinställda poser.
Tillgängliga värden: a-pose, t-pose
Name
aspect_ratio
Type
string
standard 1:1
Description
Ange bildförhållandet för den genererade bilden. Tillåtna värden beror på vald ai_model:
- nano-banana, nano-banana-2, nano-banana-2-lite, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2, gpt-image-2-5-flare, gpt-image-2-5-sunburst: 1:1, 16:9, 9:16, 4:3, 3:4, 3:2, 2:3
Tillgängliga värden:
- 1:1: Kvadratiskt format
- 16:9: Widescreen liggande
- 9:16: Widescreen stående
- 4:3: Standard liggande
- 3:4: Standard stående
- 3:2: Liggande (stöds endast av GPT Image-modellerna)
- 2:3: Stående (stöds endast av GPT Image-modellerna)
Name
remove_background
Type
boolean
standard false
Description
När detta är satt till true returneras den genererade bilden som en transparent RGBA PNG med bakgrunden borttagen, så att du kan placera motivet mot valfri bakgrund.

Returnerar

Svarets result-egenskap innehåller uppgifts-id:t för den nyligen skapade Text till bild-uppgiften.

Felscenarier

Name
400 - Bad Request
Description
Förfrågan var inte acceptabel. Vanliga orsaker:
- Saknad parameter: En obligatorisk 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
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/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

Denna endpoint gör det möjligt att hämta en Text till bild-uppgift givet ett giltigt uppgifts-id. Se The Text to Image Task Object för att se vilka egenskaper som ingår i Text till bild-uppgiftsobjektet.

Parametrar

Name
id
Type
path
Description
Unik identifierare för den Text till bild-uppgift som ska hämtas.

Returnerar

Svaret innehåller Text till bild-uppgiftsobjektet. Se avsnittet The Text to Image Task Object för mer information.

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

Ta bort en Text till bild-uppgift

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

Sökvägsparametrar

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

Uppgiftsstatus

En uppgift som fortfarande är PENDING tas bort och de credits som förbrukades vid skapandet återbetalas.

En uppgift som redan är IN_PROGRESS kan inte tas bort: förfrågan avvisas med 409 Conflict och uppgiften fortsätter att köras. Credits för en uppgift som workern redan har påbörjat är inte återbetalningsbara, så att ta bort den mitt i körningen skulle kosta dig både creditsen och resultatet. Vänta tills den når SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.

En uppgift i ett slutgiltigt tillstånd (SUCCEEDED, FAILED eller CANCELED) tas bort utan återbetalning.

Returnerar

Returnerar 200 OK vid lyckad borttagning, eller 409 Conflict när uppgiften är IN_PROGRESS.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left 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."
}

GET/openapi/v1/text-to-image

Lista Text till bild-uppgifter

Denna endpoint gör det möjligt att hämta en lista med Text till bild-uppgifter.

Parametrar

Name
page_num
Type
integer
Description
Sidnummer för paginering. Börjar på och har som standardvärde 1.
Name
page_size
Type
integer
Description
Gräns för sidstorlek. Standardvärdet är 10 objekt. Maximalt tillåtna värde är 100 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 med Text till bild-uppgiftsobjekt.

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

Streama en Text till bild-uppgift

Denna 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 den Text till bild-uppgift som ska strömmas.

Returnerar

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

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

Text till bild-uppgiftsobjektet

Text till bild-uppgiftsobjektet är en arbetsenhet som Meshy håller reda på för att generera en bild från en text prompt-indata. 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 som implementationsdetalj bör du inte göra några antaganden om formatet på id:t.
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-2-lite, nano-banana-pro, gpt-image-2, gpt-image-2-5-flare, eller gpt-image-2-5-sunburst.
Name
prompt
Type
string
Description
Textprompten 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
Förlopp (progress) för uppgiften. Om uppgiften inte har startats ännu kommer denna egenskap att vara 0. När uppgiften har lyckats blir den 100.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
En tidsstämpel representerar antalet millisekunder som förflutit sedan 1 januari 1970 UTC, enligt standarden RFC 3339. Till exempel representeras fredagen den 1 september 2023 12:00:00 PM 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 har slutförts ä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 i detta fält är endast meningsfullt om uppgiftsstatusen ä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 hela referensen till task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Finns när uppgiftsstatusen är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid fel).

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
}