Afbeelding naar afbeelding API

Afbeelding naar afbeelding API is een functie waarmee je de AI-beeldbewerkingsmogelijkheden van Meshy in je eigen applicatie kunt integreren. Transformeer en bewerk bestaande afbeeldingen met behulp van referentieafbeeldingen en tekstprompts met onze krachtige AI-modellen.

POST/openapi/v1/image-to-image

Een Afbeelding naar afbeelding-taak aanmaken

Met deze endpoint kun je een nieuwe Afbeelding naar afbeelding-taak aanmaken. Raadpleeg Het Afbeelding naar afbeelding-taakobject om te zien welke eigenschappen zijn opgenomen in het Afbeelding 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 model voor afbeeldingsbewerking (12 credits per afbeelding)
Name
prompt
Type
string
Verplicht
Description
Een tekstbeschrijving van de transformatie of bewerking die je op de referentieafbeeldingen wilt toepassen.
Name
reference_image_urls
Type
array
Verplicht
Description
Een array van 1 tot 5 referentieafbeeldingen om te gebruiken voor de afbeeldingsbewerkingstaak. We ondersteunen momenteel de indelingen .jpg, .jpeg en .png.
Er zijn twee manieren om elke afbeelding aan te leveren:
- Openbaar toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet.
- Data URI: Een base64-gecodeerde Data URI van de afbeelding. Voorbeeld van een Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
generate_multi_view
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt een afbeelding met meerdere aanzichten gegenereerd die het onderwerp vanuit meerdere hoeken toont.

Retourneert

De eigenschap result van de response bevat de taak-id van de nieuw aangemaakte Afbeelding naar afbeelding-taak.

Foutmodi

Name
400 - Bad Request
Description
De aanvraag was ongeldig. Veelvoorkomende oorzaken:
- Ontbrekende parameter: Een vereiste parameter (bijv. ai_model, prompt, reference_image_urls) ontbreekt.
- Ongeldige afbeeldingsindeling: Een of meer referentieafbeeldingen hebben niet-ondersteunde indelingen.
- Onbereikbare URL: Een of meer reference_image_urls konden niet worden gedownload.
Name
401 - Unauthorized
Description
Authenticatie is 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/image-to-image

# Transform a reference image with a text prompt
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>"
    ]
  }'


 ## Using Data URI example
curl https://api.meshy.ai/openapi/v1/image-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "reference_image_urls": [
      "data:image/png;base64,${YOUR_BASE64_ENCODED_IMAGE_DATA}"
    ]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-image/:id

Een Afbeelding naar afbeelding-taak ophalen

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

Parameters

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

Retourneert

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

Request

GET

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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/image-to-image/:id

Een Afbeelding naar afbeelding-taak verwijderen

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

Padparameters

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

Retourneert

Geeft 200 OK terug bij succes.

Request

DELETE

/openapi/v1/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/image-to-image

Afbeelding naar afbeelding-taken weergeven

Met deze endpoint kunt u een lijst met Afbeelding naar afbeelding-taken ophalen.

Parameters

Name
page_num
Type
integer
Description
Paginanummer voor paginering. Begint en is standaard 1.
Name
page_size
Type
integer
Description
Limiet voor paginagrootte. Standaard 10 items. Maximaal toegestaan is 50 items.
Name
sort_by
Type
string
Description
Veld om op te sorteren. 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 taakobjecten voor Afbeelding naar afbeelding.

Request

GET

/openapi/v1/image-to-image

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-image",
    "ai_model": "nano-banana",
    "prompt": "Transform this into a cyberpunk style artwork",
    "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/image-to-image/:id/stream

Stream een Afbeelding naar afbeelding-taak

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

Parameters

Name
id
Type
path
Description
Unieke identifier voor de Afbeelding naar afbeelding-taak om te streamen.

Retourneert

Retourneert een stream van De Afbeelding 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/image-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-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": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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 Afbeelding naar afbeelding-taakobject

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

Eigenschappen

Name
id
Type
string
Description
Unieke identificatie 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 taak voor het genereren van afbeeldingen. Voor Afbeelding naar afbeelding-taken is dit altijd image-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 tekstprompt die is gebruikt om de afbeeldingstransformatie te sturen.
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 terugbetaald bij mislukking).

Example Image to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-image",
  "ai_model": "nano-banana",
  "prompt": "Transform this into a cyberpunk style artwork",
  "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
}