Tekst naar afbeelding-API

Tekst naar afbeelding-API is een functie waarmee je de mogelijkheden voor AI-afbeeldingsgeneratie van Meshy in je eigen applicatie kunt integreren. Genereer afbeeldingen van hoge kwaliteit op basis van tekstprompts met onze krachtige AI-modellen.

POST/openapi/v1/text-to-image

Een Tekst naar afbeelding-taak maken

Met deze endpoint kun je een nieuwe Tekst naar afbeelding-taak maken. Raadpleeg Het Tekst naar afbeelding-taakobject om te zien welke eigenschappen zijn opgenomen in het Tekst naar afbeelding-taakobject.

Parameters

Name
ai_model
Type
string
Verplicht
Description
ID van het model dat moet worden gebruikt voor het genereren van afbeeldingen.
Beschikbare waarden:
- nano-banana: Standaardmodel (3 credits per afbeelding)
- nano-banana-2: Gebalanceerd model met sterkere mogelijkheden dan standaard (6 credits per afbeelding)
- nano-banana-pro: Pro-model met verbeterde kwaliteit (9 credits per afbeelding)
- gpt-image-2: OpenAI GPT Image 2, een high-fidelity afbeeldingsmodel met beperkte ondersteuning voor beeldverhoudingen (9 credits per afbeelding)
Name
prompt
Type
string
Verplicht
Description
Een tekstbeschrijving van de afbeelding die je wilt genereren. Wees beschrijvend voor de beste resultaten.
Name
generate_multi_view
Type
boolean
standaard false
Description
Wanneer ingesteld op true, genereert dit een afbeelding met meerdere aanzichten die het onderwerp vanuit meerdere hoeken toont.
Wanneer generate_multi_view true is, kan de parameter aspect_ratio niet worden ingesteld.
Name
pose_mode
Type
string
Description
Geef de pose_mode op voor het genereren van personages. Wanneer dit wordt weggelaten, wordt de afbeelding gegenereerd zonder pose-presets.
Beschikbare waarden: a-pose, t-pose
Name
aspect_ratio
Type
string
standaard 1:1
Description
Geef de beeldverhouding van de gegenereerde afbeelding op. Toegestane waarden zijn afhankelijk van de geselecteerde ai_model:
- nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2: alleen 1:1, 3:2, 2:3
Beschikbare waarden:
- 1:1: Vierkant formaat
- 16:9: Breedbeeld liggend (niet ondersteund door gpt-image-2)
- 9:16: Breedbeeld staand (niet ondersteund door gpt-image-2)
- 4:3: Standaard liggend (niet ondersteund door gpt-image-2)
- 3:4: Standaard staand (niet ondersteund door gpt-image-2)
- 3:2: Liggend (alleen ondersteund door gpt-image-2)
- 2:3: Staand (alleen ondersteund door gpt-image-2)

Retourneert

De eigenschap result van de respons bevat de taak-id van de nieuw gemaakte Tekst naar afbeelding-taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was niet acceptabel. Veelvoorkomende oorzaken:
- Ontbrekende parameter: Een vereiste parameter (bijv. ai_model, prompt) ontbreekt.
- Ongeldige parameter: ai_model of aspect_ratio is niet een van de toegestane waarden.
- Conflict: generate_multi_view en aspect_ratio kunnen niet gelijktijdig worden gebruikt.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.

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

Een Tekst naar afbeelding-taak ophalen

Met deze endpoint kun je een Tekst naar afbeelding-taak ophalen met een geldige taak-id. Raadpleeg Het Tekst naar afbeelding-taakobject om te zien welke eigenschappen zijn opgenomen in het Tekst naar afbeelding-taakobject.

Parameters

Name
id
Type
path
Description
Unieke identifier voor de Tekst naar afbeelding-taak die moet worden opgehaald.

Retourneert

De respons bevat het Tekst naar afbeelding-taakobject. Bekijk de sectie Het Tekst naar afbeelding-taakobject voor details.

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

Een Tekst naar afbeelding-taak verwijderen

Deze endpoint verwijdert een Tekst naar afbeelding-taak permanent, inclusief alle bijbehorende afbeeldingen en gegevens. Deze actie is onomkeerbaar.

Padparameters

Name
id
Type
path
Description
De ID van de Tekst naar afbeelding-taak die moet worden verwijderd.

Retourneert

Retourneert 200 OK bij succes.

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

Lijst van Tekst naar afbeelding-taken

Met deze endpoint kun je een lijst met Tekst naar afbeelding-taken ophalen.

Parameters

Name
page_num
Type
integer
Description
Paginanummer voor paginering. Begint bij en is standaard 1.
Name
page_size
Type
integer
Description
Limiet voor paginagrootte. Standaard 10 items. Het maximaal toegestane aantal is 50 items.
Name
sort_by
Type
string
Description
Veld waarop gesorteerd moet worden. Beschikbare waarden:
- +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
- -created_at: Sorteer op aanmaaktijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst van De Tekst naar afbeelding-taakobjecten.

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

Stream een Tekst naar afbeelding-taak

Deze endpoint streamt realtime-updates voor een Tekst naar afbeelding-taak met Server-Sent Events (SSE).

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de Tekst naar afbeelding-taak die moet worden gestreamd.

Retourneert

Retourneert een stream van De Tekst naar afbeelding-taakobjecten als Server-Sent Events.

Voor PENDING- of IN_PROGRESS-taken bevat de responsstream alleen de noodzakelijke velden progress en 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=***"
  ]
}

Het Tekst naar afbeelding-taakobject

Het Tekst naar afbeelding-taakobject is een werkeenheid die Meshy bijhoudt om een afbeelding te genereren op basis van invoer met een tekstprompt. Het object heeft de volgende eigenschappen:

Eigenschappen

Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we een k-sorteerbare UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Het type afbeeldingsgeneratietaak. Voor Tekst naar afbeelding-taken is dit altijd text-to-image.
Name
ai_model
Type
string
Description
Het AI-model dat voor deze taak is gebruikt. Mogelijke waarden zijn nano-banana, nano-banana-2, nano-banana-pro of gpt-image-2.
Name
prompt
Type
string
Description
De tekst-prompt die is gebruikt om de afbeelding te genereren.
Name
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.
Een tijdstempel vertegenwoordigt het aantal milliseconden dat is verstreken sinds 1 januari 1970 UTC, volgens de RFC 3339-standaard. Bijvoorbeeld: vrijdag 1 september 2023 12:00:00 PM GMT wordt weergegeven als 1693569600000. Dit is van toepassing op alle tijdstempels in Meshy API.
Name
started_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is gestart, in milliseconden. Als de taak nog niet is gestart, is deze eigenschap 0.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, is deze eigenschap 0.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
De waarde van dit veld is alleen betekenisvol als de taakstatus PENDING is.
Name
image_urls
Type
array
Description
Een array met downloadbare URL's naar de gegenereerde afbeeldingen. Wanneer generate_multi_view is ingeschakeld, bevat deze array drie afbeeldings-URL's die verschillende kijkhoeken vertegenwoordigen. Anders bevat deze één afbeeldings-URL.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige task_error-objectreferentie.
Name
consumed_credits
Type
integer
Description
Het aantal credits dat door deze taak is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS of SUCCEEDED is. Retourneert 0 voor FAILED-taken (credits worden bij een fout terugbetaald).

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
}