Tekst naar afbeelding API

Tekst naar afbeelding API is een functie waarmee je de AI-afbeeldingsgeneratiecapaciteiten van Meshy in je eigen applicatie kunt integreren. Genereer hoogwaardige afbeeldingen van tekstprompts met behulp van onze krachtige AI-modellen.

POST/openapi/v1/text-to-image

Maak een Tekst naar Afbeelding Taak

Deze endpoint stelt je in staat om een nieuwe Tekst naar Afbeelding taak te maken. Raadpleeg Het Tekst naar Afbeelding Taak Object om te zien welke eigenschappen zijn opgenomen in het Tekst naar Afbeelding taak object.

Parameters

Name
ai_model
Type
string
Verplicht
Description
ID van het model dat gebruikt moet worden voor beeldgeneratie.
Beschikbare waarden:
- nano-banana: Standaard model (3 credits per afbeelding)
- nano-banana-2: Gebalanceerd model met sterkere capaciteit 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 hoogwaardig beeldmodel (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 een afbeelding met meerdere aanzichten die het onderwerp vanuit meerdere hoeken toont.
Wanneer generate_multi_view true is, kan de aspect_ratio parameter niet worden ingesteld.
Name
pose_mode
Type
string
Description
Specificeer de pose mode voor karaktergeneratie. Wanneer weggelaten, wordt de afbeelding gegenereerd zonder enige pose presets.
Beschikbare waarden: a-pose, t-pose
Name
aspect_ratio
Type
string
standaard 1:1
Description
Specificeer de beeldverhouding van de gegenereerde afbeelding. Toegestane waarden zijn afhankelijk van het geselecteerde 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
Beschikbare waarden:
- 1:1: Vierkant formaat
- 16:9: Breedbeeld landschap
- 9:16: Breedbeeld portret
- 4:3: Standaard landschap (niet ondersteund door gpt-image-2)
- 3:4: Standaard portret (niet ondersteund door gpt-image-2)
- 3:2: Landschap (alleen ondersteund door gpt-image-2)
- 2:3: Portret (alleen ondersteund door gpt-image-2)
Name
remove_background
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de gegenereerde afbeelding geretourneerd als een transparante RGBA PNG met de achtergrond verwijderd, zodat je het onderwerp op elke achtergrond kunt samenstellen.

Retourneert

De result eigenschap van de respons bevat de taak id van de nieuw aangemaakte Tekst naar Afbeelding taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was onacceptabel. 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

Haal een Tekst naar afbeelding taak op

Deze endpoint stelt je in staat om een Tekst naar afbeelding taak op te halen met een geldig 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 identificatie voor de Tekst naar afbeelding taak om op te halen.

Retourneert

De respons bevat het Tekst naar afbeelding taakobject. Bekijk Het Tekst naar afbeelding taakobject sectie 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

Verwijder een Tekst naar afbeelding taak

Deze endpoint verwijdert permanent een Tekst naar afbeelding taak, 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 Tekst naar afbeelding taken

Deze endpoint stelt je in staat om een lijst van Tekst naar afbeelding taken op te halen.

Parameters

Name
page_num
Type
integer
Description
Paginanummer voor paginering. Begint en standaard op 1.
Name
page_size
Type
integer
Description
Limiet voor paginagrootte. Standaard is 10 items. Maximum toegestaan is 50 items.
Name
sort_by
Type
string
Description
Veld om op te sorteren. Beschikbare waarden:
- +created_at: Sorteren op creatietijd in oplopende volgorde.
- -created_at: Sorteren op creatietijd 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 real-time updates voor een Tekst naar afbeelding taak met behulp van Server-Sent Events (SSE).

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de Tekst naar afbeelding taak om te streamen.

Retourneert

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

Voor PENDING of IN_PROGRESS taken, zal de responsstream alleen de noodzakelijke progress en status velden bevatten.

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 werkunit die Meshy bijhoudt om een afbeelding te genereren vanuit een tekst prompt invoer. Het object heeft de volgende eigenschappen:

Eigenschappen

Name
id
Type
string
Description
Unieke identificatie voor de taak. Hoewel we een k-sortable UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames maken over het formaat van de id.
Name
type
Type
string
Description
Het type afbeeldingsgeneratietaak. Voor Tekst naar Afbeelding taken zal dit altijd text-to-image zijn.
Name
ai_model
Type
string
Description
Het AI-model dat voor deze taak wordt 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 werd 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
Voortgang van de taak. Als de taak nog niet is gestart, zal deze eigenschap 0 zijn. 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 geldt voor 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, zal deze eigenschap 0 zijn.
Name
finished_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, zal deze eigenschap 0 zijn.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
Name
preceding_tasks
Type
integer
Description
Het aantal voorgaande taken.
De waarde van dit veld is alleen betekenisvol als de taakstatus PENDING is.
Name
image_urls
Type
array
Description
Een array van 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 het een enkele 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. Geeft 0 terug voor FAILED taken (credits worden terugbetaald bij mislukking).

Voorbeeld Tekst naar Afbeelding Taakobject

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