Multi-afbeelding naar 3D API

De Multi-afbeelding naar 3D API is een functie waarmee u Meshy's Multi-afbeelding naar 3D-mogelijkheden in uw eigen applicatie kunt integreren. In deze sectie vindt u alle informatie die u nodig hebt om aan de slag te gaan met deze API.

POST/openapi/v1/multi-image-to-3d

Een Multi-afbeelding naar 3D-taak aanmaken

Met deze endpoint kunt u een nieuwe Multi-afbeelding naar 3D-taak aanmaken. Raadpleeg Het Multi-afbeelding naar 3D-taakobject om te zien welke eigenschappen deel uitmaken van het Multi-afbeelding naar 3D-taakobject.

De taak wordt op de achtergrond uitgevoerd. Zie Verwerkingstijden voor hoe lang dit gewoonlijk duurt.

Parameters

Slechts één van input_task_id of image_urls is verplicht. Als beide worden opgegeven, heeft input_task_id prioriteit.

Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide afbeeldingsgeneratietaak waarvan de output (1-4 afbeeldingen) moet worden gebruikt als invoer. Deze taak moet een van de volgende taken zijn: Tekst naar afbeelding, Afbeelding naar afbeelding, Tekst naar afbeelding Meerdere aanzichten, of Afbeelding naar afbeelding Meerdere aanzichten. Daarnaast moet deze via de API zijn uitgevoerd en de status SUCCEEDED hebben.

Name
image_urls
Type
array
Verplicht
Description
Geef 1 tot 4 afbeeldingen op die Meshy kan gebruiken bij het maken van het model. We ondersteunen momenteel de formaten .jpg, .jpeg, .png en .webp. Voor het beste resultaat moeten alle afbeeldingen hetzelfde object vanuit verschillende hoeken tonen.
Maximale bestandsgrootte: 20 MB per afbeelding.
Er zijn twee manieren om elke afbeelding op te geven:
- 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>.
Voor meshy-7.1 (of latest) wordt de eerste afbeelding gebruikt als het primaire (voor)aanzicht. De volgorde van de overige afbeeldingen maakt niet uit.

Name
ai_model
Type
string
standaard latest
Description
ID van het te gebruiken model.
Beschikbare waarden:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (verouderd): gebruik in plaats daarvan meshy-7.1.
Name
geometry_resolution
Type
string
standaard standard
Description
Doorgang voor geometriegeneratie. 2k voert de Ultra-pass uit op 2048³. Vereist meshy-7.1 of latest.
Beschikbare waarden: standard, 2k
Name
ultra_mode
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan geometry_resolution. ultra_mode: true is gelijk aan geometry_resolution: "2k".
Name
should_texture
Type
boolean
standaard true
Description
Bepaalt of texturen worden gegenereerd. Als dit op false wordt gezet, wordt de texturingsfase overgeslagen en wordt een mesh zonder texturen geleverd.

Alleen van toepassing wanneer should_texture = true

Name
enable_pbr
Type
boolean
standaard false
Description
Genereer PBR-maps (metallic, roughness, normal) naast de basiskleur. Er wordt ook een emissiemap toegevoegd wanneer ai_model meshy-6 is, behalve bij texture_resolution: 8k. meshy-6-lite, meshy-7.1 en latest produceren geen emissiemap.
Name
texture_resolution
Type
string
standaard 2k
Description
Resolutie van de basiskleurtextuur. Een van 2k (2048×2048), 4k (4096×4096) of 8k (8192×8192). Hogere resoluties leggen meer oppervlaktedetail vast.
4k en 8k vereisen ai_model meshy-6, meshy-7.1 of latest. Bij 8k wordt geen emissiemap geproduceerd.
Name
hd_texture
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan texture_resolution — gelijk aan texture_resolution: "4k". Wanneer beide zijn ingesteld, heeft texture_resolution voorrang.
Name
texture_prompt
Type
string
Description
Geef een tekstprompt op om het textureringsproces te sturen. Maximaal 800 tekens.
Name
texture_image_url
Type
string
Description
Geef een 2D-afbeelding op om het textureringsproces te sturen. We ondersteunen momenteel de formaten .jpg, .jpeg, .png en .webp.
Maximale bestandsgrootte: 20 MB.
Er zijn twee manieren om de afbeelding op te geven:
- 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>
Afbeeldingstexturering werkt mogelijk niet optimaal als er aanzienlijke geometrische verschillen zijn tussen het oorspronkelijke asset en de geüploade afbeelding. Slechts één van texture_image_url of texture_prompt kan worden gebruikt om het textureringsproces te sturen. Als beide parameters worden opgegeven, wordt standaard texture_prompt gebruikt om het model te textureren.
Name
texture_image_urls
Type
string[]
Description
Geef 1 tot 4 afbeeldingen op die hetzelfde object vanuit verschillende aanzichten tonen om de texturering te sturen. De eerste afbeelding is het primaire (voor)aanzicht; de volgorde van de overige aanzichten (links, achter, rechts) maakt niet uit.
Elk element accepteert dezelfde formaten als texture_image_url (een publiek toegankelijke URL of een base64-data-URI, .jpg/.jpeg/.png/.webp).
Maximale bestandsgrootte: 20 MB per afbeelding.
Deze afbeeldingen sturen alleen de textuur en staan los van image_urls — de twee lijsten kunnen verschillende afbeeldingen en verschillende aantallen afbeeldingen bevatten.
Vereist ai_model meshy-7.1 of latest. Kan niet worden gecombineerd met texture_image_url of texture_prompt.

Name
should_remesh
Type
boolean
standaard false (Meshy 6 and Meshy 7 models), true (others)
Description
Bepaalt of de remesh-fase wordt ingeschakeld. Voor het model met de hoogste kwaliteit raden we aan should_remesh op false te zetten.

Alleen van toepassing wanneer should_remesh = true

Name
topology
Type
string
standaard triangle
Description
Geef de topology van het gegenereerde model op.
Beschikbare waarden:
- quad: genereer een quad-dominante mesh.
- triangle: genereer een gedecimeerde driehoeksmesh.
Name
target_polycount
Type
integer
standaard 30,000
Description
Geef het beoogde aantal polygonen in het gegenereerde model op. Het werkelijke aantal polygonen kan afwijken van het doel, afhankelijk van de complexiteit van de geometrie.
Het geldige bereik is 100 tot 300.000 (inclusief).
Name
decimation_mode
Type
integer
Description
Schakel adaptieve decimatie in door een polygonaantal-niveau in te stellen. Wanneer dit is ingesteld, wordt target_polycount genegeerd.
Beschikbare waarden:
- 1: Adaptief — ultra polygonaantal.
- 2: Adaptief — hoog polygonaantal.
- 3: Adaptief — gemiddeld polygonaantal.
- 4: Adaptief — laag polygonaantal.
Name
save_pre_remeshed_model
Type
boolean
standaard false
Description
Wanneer dit op true is ingesteld, slaat Meshy ook een extra GLB-bestand op voordat de remesh-fase is voltooid.

Name
symmetry_mode
Type
string
⚠ verouderd
standaard auto
Description
Verouderd. Deze parameter heeft geen invloed meer op de output.
Het veld symmetry_mode bepaalt het symmetriegedrag tijdens het modelgeneratieproces.
De geldige waarden zijn:
- off: schakelt symmetrie uit.
- auto: bepaalt en past symmetrie automatisch toe op basis van de invoergeometrie.
- on: dwingt symmetrie af tijdens het genereren.
Name
pose_mode
Type
string
standaard ""
Description
Geef de pose mode op voor het gegenereerde model.
Beschikbare waarden:
- a-pose: genereer het model in een A-pose.
- t-pose: genereer het model in een T-pose.
- "" (lege tekenreeks): geen specifieke pose toegepast.
Name
is_a_t_pose
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan pose_mode. Of het model in een A/T-pose moet worden gegenereerd.
Name
image_enhancement
Type
boolean
standaard true
Description
Optimaliseert de invoerafbeeldingen voor betere resultaten. Zet dit op false om het exacte uiterlijk van de invoerafbeeldingen te behouden zonder stijlbewerking.
Alleen ondersteund wanneer ai_model meshy-6, meshy-7.1 of latest is. Het instellen hiervan met meshy-6-lite geeft een foutmelding.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert hooglichten en schaduwen uit de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt bij aangepaste belichtingsopstellingen.
Alleen ondersteund wanneer ai_model meshy-6, meshy-7.1 of latest is. Het instellen hiervan met meshy-6-lite geeft een foutmelding.
Name
moderation
Type
boolean
standaard false
Description
Wanneer dit op true is ingesteld, wordt de invoerinhoud automatisch gescreend op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet door naar de generatiefase.
Elke afbeelding uit image_urls en de tekst uit texture_prompt worden gescreend.
Name
target_formats
Type
string[]
Description
Geeft aan welke 3D-bestandsformaten moeten worden opgenomen in de output. Alleen de gevraagde formaten worden gegenereerd en geretourneerd, wat de voltooiingstijd van de taak kan verkorten.
Beschikbare waarden: glb, obj, fbx, stl, usdz, 3mf
Indien weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer dit expliciet wordt opgegeven.
Name
auto_size
Type
boolean
standaard false
Description
Wanneer dit op true is ingesteld, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig in formaat aan te passen. De oorsprong wordt standaard bottom, tenzij origin_at expliciet is ingesteld.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer dit op true is ingesteld, rendert de taak bovendien een versie van de preview met transparante achtergrond (RGBA) en retourneert deze als alpha_thumbnail_url in de GET-respons. Het bestaande veld thumbnail_url blijft ongewijzigd.
Name
multi_view_thumbnails
Type
boolean
standaard false
Description
Wanneer dit op true is ingesteld, rendert de taak bovendien vier thumbnails vanuit de hoofdaanzichten (voor, rechts, achter, links) en retourneert deze onder thumbnail_urls in de GET-respons. Het bestaande veld thumbnail_url blijft ongewijzigd en blijft verwijzen naar het vooraanzicht, zodat bestaande clients niet worden beïnvloed.
Voegt ongeveer 3 seconden toe aan de taaklatentie.

Alleen van toepassing wanneer auto_size = true

Name
origin_at
Type
string
standaard bottom
Description
Positie van de oorsprong wanneer auto_size is ingeschakeld. Beschikbare waarden: bottom, center.

Returns

De eigenschap result van de respons bevat de taak-id van de nieuw aangemaakte Multi-afbeelding naar 3D-taak.

Foutmodi

Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
- Ontbrekende parameter: er moet ofwel image_urls of input_task_id worden opgegeven.
- Ongeldige invoertaak: input_task_id moet verwijzen naar een SUCCEEDED Tekst naar afbeelding-, Afbeelding naar afbeelding-, of multi-view-variant-taak.
- Ongeldig aantal afbeeldingen: image_urls moet tussen 1 en 4 afbeeldingen bevatten, en texture_image_urls tussen 1 en 4.
- Ongeldig afbeeldingsformaat: een of meer afbeeldingen in image_urls hebben niet-ondersteunde formaten.
- Conflicterende textuurinvoer: texture_image_urls kan niet worden gecombineerd met texture_image_url of texture_prompt, en vereist should_texture: true.
- Niet-ondersteund model voor multi-view-textuur: texture_image_urls vereist ai_model meshy-7.1 of latest.
- Onbereikbare URL: een of meer elementen van image_urls of texture_image_urls konden niet worden gedownload.
- Afbeelding te groot: een of meer afbeeldingen van image_urls, texture_image_url of texture_image_urls overschrijden 20 MB.
- Niet-ondersteunde resolutie voor invoer met meerdere afbeeldingen: geometry_resolution: "4k" is niet beschikbaar op deze endpoint; gebruik 2k of standard.
- Niet-ondersteund model voor afbeeldingsopties: image_enhancement of remove_lighting is ingesteld met ai_model: "meshy-6-lite".
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer uw API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
429 - Too Many Requests
Description
U heeft uw rate limit overschreden.

Request

POST

/openapi/v1/multi-image-to-3d

# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ]
  }'

# With Ultra 2K geometry, PBR texturing and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "geometry_resolution": "2k",
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

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

GET/openapi/v1/multi-image-to-3d/:id

Een Multi-afbeelding naar 3D-taak ophalen

Met deze endpoint kunt u een Multi-afbeelding naar 3D-taak ophalen met een geldige taak-id. Raadpleeg Het Multi-afbeelding naar 3D-taakobject om te zien welke eigenschappen deel uitmaken van het Multi-afbeelding naar 3D-taakobject.

Parameters

Name
id
Type
path
Description
Unieke identificatie voor de op te halen Multi-afbeelding naar 3D-taak.

Retourwaarden

De respons bevat het Multi-afbeelding naar 3D-taakobject. Zie het gedeelte Het Multi-afbeelding naar 3D-taakobject voor details.

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

DELETE/openapi/v1/multi-image-to-3d/:id

Een Multi-afbeelding naar 3D-taak verwijderen

Deze endpoint verwijdert een Multi-afbeelding naar 3D-taak permanent, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Padparameters

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

Taakstatus

Een taak die nog PENDING is, wordt verwijderd en de credits die bij het aanmaken zijn verbruikt, worden terugbetaald.

Een taak die al IN_PROGRESS is, kan niet worden verwijderd: het verzoek wordt geweigerd met 409 Conflict en de taak blijft actief. Credits voor een taak waarvoor de worker al is gestart, zijn niet terugbetaalbaar, dus het verwijderen ervan tijdens de uitvoering zou u zowel de credits als het resultaat kosten. Wacht tot de status SUCCEEDED, FAILED of CANCELED bereikt, en verwijder de taak dan.

Een taak in een eindstatus (SUCCEEDED, FAILED of CANCELED) wordt verwijderd zonder terugbetaling.

Retourwaarden

Retourneert 200 OK bij succes, of 409 Conflict wanneer de taak IN_PROGRESS is.

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/multi-image-to-3d/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/multi-image-to-3d

Multi-afbeelding naar 3D-taken weergeven

Met deze endpoint kun je een lijst met Multi-afbeelding naar 3D-taken ophalen.

Parameters

Optionele attributen

Name
page_num
Type
integer
Description
Paginanummer voor paginering. Begint bij en standaard 1.
Name
page_size
Type
integer
Description
Paginagrootte limiet. Standaard 10 items. Maximaal toegestaan is 100 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 Multi-afbeelding naar 3D Task Objects.

Request

GET

/openapi/v1/multi-image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 30
  }
]

GET/openapi/v1/multi-image-to-3d/:id/stream

Stream een Multi-afbeelding naar 3D-taak

Deze endpoint streamt realtime updates voor een Multi-afbeelding naar 3D-taak via Server-Sent Events (SSE).

Parameters

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

Retourneert

Retourneert een stream van De Multi-afbeelding naar 3D Task Objects als Server-Sent Events.

Voor taken met status PENDING of IN_PROGRESS bevat de responsstream alleen de noodzakelijke velden progress en status.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/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": "multi-image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
  "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
  "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
  "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
  "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30
}

The Multi-afbeelding naar 3D Task Object

Het Multi-afbeelding naar 3D Task-object is een werkeenheid die Meshy bijhoudt om een 3D-model te genereren op basis van meerdere afbeeldingen (tussen 1 en 4 inclusief). De afbeeldingen moeten van hetzelfde object zijn, bij voorkeur vanuit verschillende weergaven of hoeken. Het object heeft de volgende eigenschappen:

Eigenschappen

Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we als implementatiedetail een k-sorteerbare UUID gebruiken voor taak-id's, mag je geen aannames doen over het formaat van de id.
Name
type
Type
string
Description
Type van de Multi-afbeelding naar 3D-taak. De waarde is multi-image-to-3d.
Name
model_urls
Type
object
Description
Downloadbare URL naar het getextureerde 3D-modelbestand dat door Meshy is gegenereerd. De eigenschap voor een formaat wordt weggelaten als het formaat niet is gegenereerd, in plaats van een lege string terug te geven.
- Name
  glb
  Type
  string
  Description
  Downloadbare URL naar het GLB-bestand.
- Name
  fbx
  Type
  string
  Description
  Downloadbare URL naar het FBX-bestand.
- Name
  obj
  Type
  string
  Description
  Downloadbare URL naar het OBJ-bestand.
- Name
  usdz
  Type
  string
  Description
  Downloadbare URL naar het USDZ-bestand.
- Name
  mtl
  Type
  string
  Description
  Downloadbare URL naar het MTL-bestand, geretourneerd samen met OBJ-exports wanneer texturen aanwezig zijn.
- Name
  stl
  Type
  string
  Description
  Downloadbare URL naar het STL-bestand.
- Name
  3mf
  Type
  string
  Description
  Downloadbare URL naar het 3MF-bestand. Alleen aanwezig wanneer 3mf werd aangevraagd via target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadbare URL naar de originele GLB-output voordat deze is geremesht.
  Alleen beschikbaar wanneer de taak is aangemaakt met zowel should_remesh: true als save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Downloadbare URL naar de thumbnail-afbeelding van het modelbestand. Gelijkwaardig aan thumbnail_urls.front indien aanwezig, behouden voor achterwaartse compatibiliteit.
Name
alpha_thumbnail_url
Type
string
Description
Downloadbare URL naar een versie van thumbnail_url met transparante achtergrond (RGBA). Alleen aanwezig wanneer de taak is aangemaakt met alpha_thumbnail: true en de transparante preview succesvol is gerenderd; anders wordt dit veld weggelaten.
Name
thumbnail_urls
Type
object
Description
Downloadbare URL's voor vier thumbnails van het gegenereerde 3D-model vanuit de kardinale richtingen. Elke waarde is een ondertekende URL naar een 512×512 PNG, gerenderd met dezelfde materialen en belichting als thumbnail_url. Handig om het model vanuit meerdere hoeken te bekijken in batchpijplijnen zonder de GLB te downloaden.
Alleen aanwezig wanneer de taak is aangemaakt met multi_view_thumbnails: true en de status SUCCEEDED heeft bereikt. Oudere taken en taken die zijn aangemaakt zonder deze opt-in bevatten dit veld niet.
- Name
  front
  Type
  string
  Description
  Vooraanzicht, 0° rotatie rond de verticale as (komt overeen met thumbnail_url).
- Name
  right
  Type
  string
  Description
  Rechteraanzicht, 90° rotatie.
- Name
  back
  Type
  string
  Description
  Achteraanzicht, 180° rotatie.
- Name
  left
  Type
  string
  Description
  Linkeraanzicht, 270° rotatie.
Name
texture_prompt
Type
string
Description
De tekstprompt die is gebruikt om het textureringsproces te sturen.
Name
texture_image_urls
Type
string[]
Description
Downloadbare URL's naar de textuurreferentieafbeeldingen die zijn gebruikt om de taak aan te maken, in de volgorde waarin ze zijn aangeleverd. Alleen aanwezig wanneer de taak is aangemaakt met texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ verouderd
Description
Verouderd; lees in plaats daarvan geometry_resolution.
Name
geometry_resolution
Type
string
Description
De Ultra-tier waarmee de taak is uitgevoerd (2k); weggelaten voor standard.
Name
progress
Type
integer
Description
Voortgang van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.
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.
Een tijdstempel vertegenwoordigt het aantal milliseconden dat is verstreken sinds 1 januari 1970 UTC, volgens de standaard RFC 3339. Bijvoorbeeld, vrijdag 1 september 2023 12:00:00 PM GMT wordt weergegeven als 1693569600000. Dit geldt voor alle tijdstempels in de Meshy API.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, in milliseconden.
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
status
Type
string
Description
Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Een array van textuur-URL-objecten die door de taak zijn gegenereerd. Normaal gesproken bevat dit slechts één textuur-URL-object. Elke textuur-URL heeft de volgende eigenschappen:
- Name
  base_color
  Type
  string
  Description
  Downloadbare URL naar de base color map-afbeelding.
- Name
  metallic
  Type
  string
  Description
  Downloadbare URL naar de metallic map-afbeelding.
  Als de taak is aangemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  normal
  Type
  string
  Description
  Downloadbare URL naar de normal map-afbeelding.
  Als de taak is aangemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  roughness
  Type
  string
  Description
  Downloadbare URL naar de roughness map-afbeelding.
  Als de taak is aangemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
- Name
  emission
  Type
  string
  Description
  Downloadbare URL naar de emission map-afbeelding.
  Als de taak is aangemaakt met enable_pbr: false, of als ai_model meshy-6-lite, meshy-7.1 of latest is, wordt deze eigenschap weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
De waarde van dit veld is alleen relevant als de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.
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).

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 30,
}