Multi-afbeelding naar 3D API is een functie waarmee je de Multi-afbeelding naar 3D mogelijkheden van Meshy in je eigen applicatie kunt integreren. In deze sectie vind je alle informatie
die je nodig hebt om aan de slag te gaan met deze API.
Dit endpoint stelt je in staat om een nieuwe Multi-afbeelding naar 3D taak te maken. Raadpleeg
The Multi-Image to 3D Task Object om te zien welke
eigenschappen zijn opgenomen in het Multi-afbeelding naar 3D taakobject.
Parameters
Slechts een van input_task_id of image_urls is vereist. Als beide worden verstrekt, heeft input_task_id voorrang.
Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide afbeeldings-generatietaak waarvan de uitvoer (1-4 afbeeldingen) als invoer moet worden gebruikt. 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. Bovendien moet het via de API zijn uitgevoerd en een status van SUCCEEDED hebben.
Name
image_urls
Type
array
Verplicht
Description
Bied 1 tot 4 afbeeldingen aan die Meshy kan gebruiken bij het maken van het model. We ondersteunen momenteel de formaten .jpg, .jpeg, en .png. Alle afbeeldingen moeten hetzelfde object vanuit verschillende hoeken weergeven voor de beste resultaten.
Er zijn twee manieren om elke afbeelding te leveren:
Publiekelijk toegankelijke URL: Een URL die toegankelijk is vanaf het publieke internet.
Data URI: Een base64-gecodeerde data URI van de afbeelding. Voorbeeld van een data URI: data:image/jpeg;base64,<je base64-gecodeerde afbeeldingsgegevens>.
Voor meshy-7 (of latest) wordt de eerste afbeelding gebruikt als de primaire (voor)weergave. De volgorde van de overige afbeeldingen maakt niet uit.
Name
ai_model
Type
string
standaard latest
Description
ID van het model dat gebruikt moet worden. Beschikbare waarden: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
should_texture
Type
boolean
standaard true
Description
Bepaalt of texturen worden gegenereerd. De instelling false overslaat de textuurfase, waardoor een mesh zonder texturen wordt 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. Een emissiemap is ook inbegrepen wanneer ai_modelmeshy-6 is, behalve bij texture_resolution: 8k. meshy-7 en latest produceren geen emissiemap.
Name
texture_resolution
Type
string
standaard 2k
Description
Basis kleur textuurresolutie. Eén van 2k (2048×2048), 4k (4096×4096), of 8k (8192×8192). Hogere resoluties vangen meer oppervlakdetail.
4k en 8k vereisen ai_modelmeshy-6, meshy-7 of latest. Bij 8k wordt er geen emissiemap geproduceerd.
Name
hd_texture
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan texture_resolution — equivalent aan texture_resolution: "4k". Wanneer beide zijn ingesteld, heeft texture_resolution voorrang.
Name
texture_prompt
Type
string
Description
Geef een tekstprompt om het textureringsproces te begeleiden. Maximaal 600 tekens.
Name
texture_image_url
Type
string
Description
Bied een 2d-afbeelding aan om het textureringsproces te begeleiden. We ondersteunen momenteel de formaten .jpg, .jpeg, en .png.
Er zijn twee manieren om de afbeelding te leveren:
Publiekelijk toegankelijke URL: Een URL die toegankelijk is vanaf het publieke internet
Data URI: Een base64-gecodeerde data URI van de afbeelding. Voorbeeld van een data URI: data:image/jpeg;base64,<je base64-gecodeerde afbeeldingsgegevens>
Afbeeldingtexturering werkt mogelijk niet optimaal als er aanzienlijke geometrieverschillen zijn tussen het originele asset en de geüploade afbeelding. Slechts één van texture_image_url of texture_prompt mag worden gebruikt om het textureringsproces te begeleiden. Als beide parameters worden verstrekt, dan zal standaard texture_prompt worden gebruikt om het model te texturen.
Name
should_remesh
Type
boolean
standaard false (meshy-6), true (others)
Description
Bepaalt of je de remesh-fase wilt inschakelen. Voor het model van de hoogste kwaliteit raden we aan should_remesh in te stellen op false.
Alleen van toepassing wanneer should_remesh = true
Name
topology
Type
string
standaard triangle
Description
Specificeer de topology van het gegenereerde model.
Beschikbare waarden:
quad: Genereer een kwadrantdominant mesh.
triangle: Genereer een gedecimeerd triangle mesh.
Name
target_polycount
Type
integer
standaard 30,000
Description
Specificeer het doel aantal polygonen in het gegenereerde model. Het daadwerkelijke aantal polygonen kan afwijken van het doel afhankelijk van de complexiteit van de geometrie.
Het bereik van geldige waarden varieert afhankelijk van het gebruikersniveau:
100 tot 300,000 (inclusief)
Name
decimation_mode
Type
integer
Description
Schakel adaptieve decimatie in door een polygonaantalniveau in te stellen. Wanneer 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 ingesteld op true, 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 uitvoering.
Het veld symmetry_mode regelt het symmetriegedrag tijdens het modelgeneratieproces.
De geldige waarden zijn:
off: Schakelt symmetrie uit.
auto: Bepaalt en past automatisch symmetrie toe op basis van de invoergeometrie.
on: Handhaaft symmetrie tijdens de generatie.
Name
pose_mode
Type
string
standaard ""
Description
Specificeer de pose-modus 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 string): Er wordt 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. Stel in op false om het exacte uiterlijk van de invoerafbeeldingen te behouden zonder enige stijlverwerking.
Alleen ondersteund wanneer ai_modelmeshy-6, meshy-7 of latest is.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert hooglichten en schaduwen van de basiskleur textuur, waardoor een schoner resultaat ontstaat dat beter werkt onder aangepaste verlichtinginstellingen.
Alleen ondersteund wanneer ai_modelmeshy-6, meshy-7 of latest is.
Name
moderation
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de invoerinhoud automatisch gescreend op mogelijke schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, zal de taak niet doorgaan tot generatie.
Elke afbeelding van image_urls en de tekst van texture_prompt zal worden gescreend.
Name
target_formats
Type
string[]
Description
Specificeert welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de gevraagde formaten worden gegenereerd en geretourneerd, wat de taakuitvoeringstijd kan verkorten.
Wanneer weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen als het expliciet is gespecificeerd.
Name
auto_size
Type
boolean
standaard false
Description
Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object in te schatten en het model dienovereenkomstig te schalen. De oorsprong zal standaard bottom zijn, tenzij origin_at expliciet is ingesteld.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer ingesteld op true, rendert de taak daarnaast een versie van de preview met een transparante achtergrond (RGBA) en retourneert deze als alpha_thumbnail_url in de GET-respons. Het bestaande thumbnail_url-veld blijft ongewijzigd.
Name
multi_view_thumbnails
Type
boolean
standaard false
Description
Wanneer ingesteld op true, rendert de taak daarnaast vier thumbnails van kardinale weergaven (voor, rechts, achter, links) en retourneert deze onder thumbnail_urls in de GET-respons. Het bestaande thumbnail_url-veld blijft ongewijzigd en blijft verwijzen naar de vooraanzichtweergave, zodat bestaande clients onaangetast blijven.
Voegt ongeveer 3 seconden toe aan de taakwachttijd.
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.
Retourwaarden
De result eigenschap 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 verstrekt.
Ongeldige invoertaak: De input_task_id moet verwijzen naar een SUCCEEDED Tekst naar afbeelding, Afbeelding naar afbeelding of multi-view varianttaak.
Ongeldig afbeelding aantal: image_urls moeten tussen de 1 en 4 afbeeldingen bevatten.
Ongeldig afbeeldingformaat: Een of meer afbeeldingen in image_urls zijn niet-ondersteunde formaten.
Onbereikbare URL: Een of meer 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/multi-image-to-3d
# Eenvoudig verzoekcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<jouw publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde data URI>", "<je tweede publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde data URI>" ] }'# Met PBR-texturering en GLB-formaatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<jouw publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde data URI>", "<je tweede publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Dit endpoint stelt je in staat om een Multi-afbeelding naar 3D taak op te halen met een geldig taak id.
Raadpleeg The Multi-Image to 3D Task Object om te zien welke
eigenschappen zijn opgenomen in het Multi-afbeelding naar 3D taakobject.
Parameters
Name
id
Type
path
Description
Unieke identifier voor de Multi-afbeelding naar 3D taak om op te halen.
Het Multi-afbeelding naar 3D taakobject is een werkunit die Meshy bijhoudt om een 3d-model te genereren van meerdere afbeeldingen (tussen 1 tot en met 4). De afbeeldingen zouden van hetzelfde object moeten zijn, bij voorkeur vanuit verschillende aanzichten of hoeken.
Het object heeft de volgende eigenschappen:
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we een k-sortable UUID gebruiken voor taak ids als
implementatie detail, zou je geen aannames moeten maken 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 het retourneren van een lege string.
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 naast OBJ exporten 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 gevraagd via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Downloadbare URL naar de originele GLB-uitvoer voor de remesh.
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 thumbnailafbeelding van het modelbestand. Equivalent aan thumbnail_urls.front wanneer aanwezig, bewaard voor achterwaartse compatibiliteit.
Name
alpha_thumbnail_url
Type
string
Description
Downloadbare URL naar een versie met doorzichtige achtergrond (RGBA) van thumbnail_url. Alleen aanwezig wanneer de taak is aangemaakt met alpha_thumbnail: true en de doorzichtige preview succesvol is gerenderd; anders wordt dit veld weggelaten.
Name
thumbnail_urls
Type
object
Description
Downloadbare URL's voor vier thumbnails van kardinale weergaven van het gegenereerde 3D-model. Elke waarde is een ondertekende URL naar een 512×512 PNG gerenderd met dezelfde materialen en verlichting als thumbnail_url. Nuttig voor het bekijken van het model vanuit meerdere hoeken in batch-pijpleidingen zonder de GLB te downloaden.
Alleen aanwezig wanneer de taak is aangemaakt met multi_view_thumbnails: true en SUCCEEDED heeft bereikt. Oudere taken en taken die zonder de opt-in zijn aangemaakt, zullen dit veld niet bevatten.
Name
front
Type
string
Description
Vooraanzicht, 0° rotatie rond de verticale as (komt overeen met thumbnail_url).
Name
right
Type
string
Description
Rechtsaanzicht, 90° rotatie.
Name
back
Type
string
Description
Achteraanzicht, 180° rotatie.
Name
left
Type
string
Description
Linker aanzicht, 270° rotatie.
Name
texture_prompt
Type
string
Description
De tekstprompt die werd gebruikt om het textureringsproces te begeleiden.
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, zal dit 100 worden.
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.
Een tijdstempel vertegenwoordigt het aantal verstreken milliseconden sinds 1 januari 1970 UTC, volgens
de RFC 3339 standaard.
Vrijdag 1 september 2023 12:00:00 PM GMT wordt bijvoorbeeld weergegeven als 1693569600000. Dit geldt
voor alle tijdstempels in 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, zal deze eigenschap 0 zijn.
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 zijn gegenereerd uit de taak. 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 basiskleurafbeelding.
Name
metallic
Type
string
Description
Downloadbare URL naar de metallic afbeelding.
Als de taak is aangemaakt met enable_pbr: false, zal deze eigenschap worden weggelaten.
Name
normal
Type
string
Description
Downloadbare URL naar de normal map afbeelding.
Als de taak is aangemaakt met enable_pbr: false, zal deze eigenschap worden weggelaten.
Name
roughness
Type
string
Description
Downloadbare URL naar de roughness map afbeelding.
Als de taak is aangemaakt met enable_pbr: false, zal deze eigenschap worden weggelaten.
Name
emission
Type
string
Description
Downloadbare URL naar de emissie afbeelding.
Als de taak is aangemaakt met enable_pbr: false, of ai_model is meshy-5, zal deze eigenschap worden weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorgaande taken.
De waarde van dit veld is alleen zinvol als de taakstatus PENDING is.
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 wordt verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS, of SUCCEEDED is. Retourneert 0 voor FAILED taken (credits worden terugbetaald bij mislukking).