Afbeelding naar afbeelding API

Afbeelding naar afbeelding API is een functie waarmee je de AI-afbeeldingsbewerkingsmogelijkheden 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

Maak een Afbeelding naar Afbeelding Taak

Deze endpoint stelt je in staat om een nieuwe Afbeelding naar Afbeelding taak te maken. Raadpleeg Het Afbeelding naar Afbeelding Taak Object 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 gebruikt moet worden voor beeldgeneratie.
Beschikbare waarden:
- nano-banana: Standaardmodel (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 model voor hoge-fidelity beeldbewerking (12 credits per afbeelding)
Name
prompt
Type
string
Verplicht
Description
Een tekstbeschrijving van de transformatie of bewerking die je wilt toepassen op de referentieafbeeldingen.
Name
reference_image_urls
Type
array
Verplicht
Description
Een array van 1 tot 5 referentieafbeeldingen die gebruikt worden voor de beeldbewerkingsopdracht. We ondersteunen momenteel .jpg, .jpeg, en .png formaten.
Er zijn twee manieren om elke afbeelding te leveren:
- Publiek 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, 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
aspect_ratio
Type
string
standaard 1:1
Description
Specificeer de beeldverhouding van de uitvoerafbeelding. 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: Breedbeeldlandschap
- 9:16: Breedbeeldportret
- 4:3: Standaardlandschap (niet ondersteund door gpt-image-2)
- 3:4: Standaardportret (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 uitvoerafbeelding 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 Afbeelding naar Afbeelding taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
- Ontbrekende parameter: Een vereiste parameter (bijv. ai_model, prompt, reference_image_urls) ontbreekt.
- Ongeldig afbeeldingsformaat: Een of meer referentieafbeeldingen zijn niet ondersteunde formaten.
- Onbereikbare URL: Een of meer reference_image_urls konden niet worden gedownload.
- Ongeldige parameter: aspect_ratio is niet een van de toegestane waarden voor het geselecteerde ai_model.
- 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/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

Haal een Afbeelding naar afbeelding Taak op

Deze endpoint stelt je in staat om een Afbeelding naar afbeelding taak op te halen met een geldig taak id. Raadpleeg Het Afbeelding naar afbeelding Taak Object om te zien welke eigenschappen zijn opgenomen in het Afbeelding naar afbeelding taakobject.

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de Afbeelding naar afbeelding taak om op te halen.

Retourneert

De respons bevat het Afbeelding naar afbeelding taakobject. Bekijk de sectie Het Afbeelding naar afbeelding Taak Object 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

Verwijder een Afbeelding naar afbeelding Taak

Deze 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

Retourneert 200 OK 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

Lijst Afbeelding naar afbeelding Taken

Deze endpoint stelt je in staat om een lijst van Afbeelding 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 op 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 Afbeelding naar afbeelding Taakobjecten.

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 real-time updates voor een Afbeelding naar afbeelding taak met behulp van Server-Sent Events (SSE).

Parameters

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

Retourneert

Retourneert een stream van De Afbeelding 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/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 werkunit die Meshy bijhoudt om een afbeelding te genereren vanuit referentieafbeeldingen en een tekstprompt 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 maken over het formaat van de id.
Name
type
Type
string
Description
Het type afbeeldingsgeneratietaak. Voor Afbeelding naar afbeelding taken zal dit altijd image-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 tekstprompt die werd gebruikt om de afbeeldingstransformatie te begeleiden.
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 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 Afbeelding naar afbeelding Taakobject

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