Beeld naar 3D API is een functie waarmee je de mogelijkheden van Meshy's Beeld naar 3D in je eigen toepassing kunt integreren. In dit gedeelte vind je alle informatie die je nodig hebt om aan de slag te gaan met deze API.
Deze endpoint stelt je in staat om een nieuwe Beeld naar 3D taak te creëren. Raadpleeg
Het Beeld naar 3D Taak Object om te zien welke
eigenschappen zijn opgenomen in het Beeld naar 3D taakobject.
Parameters
Slechts één van input_task_id of image_url is vereist. Als beide worden verstrekt, krijgt input_task_id prioriteit.
Name
input_task_id
Type
string
Verplicht
Description
Het ID van een voltooide beeld-generatietaak waarvan de output moet worden gebruikt als de afbeeldingsinput. Deze taak moet een van de volgende taken zijn: Tekst naar Afbeelding of Afbeelding naar Afbeelding. Bovendien moet deze via de API zijn uitgevoerd, de status SUCCEEDED hebben en precies één afbeelding opleveren.
Name
image_url
Type
string
Verplicht
Description
Lever een afbeelding voor Meshy om te gebruiken bij het maken van het model. We ondersteunen momenteel .jpg, .jpeg, en .png formaten.
Er zijn twee manieren om de afbeelding te leveren:
Publiek 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,<jouw base64-gecodeerde afbeeldingsgegevens>.
Name
model_type
Type
string
standaard standard
Description
Specificeer het type 3D mesh-generatie.
Beschikbare waarden:
standard: Reguliere hoge-detail 3D mesh-generatie.
smart-topology: Kies een Smart Topology model met ai_model (meshy-t1 of meshy-t2).
lowpoly (verouderd): Genereert low-poly mesh geoptimaliseerd voor schonere polygonen. We raden aan om smart-topology te gebruiken.
Wanneer smart-topology is geselecteerd, worden topology, should_remesh en save_pre_remeshed_model genegeerd.
Wanneer lowpoly is geselecteerd, worden ai_model, topology, target_polycount, should_remesh en save_pre_remeshed_model genegeerd.
Name
ai_model
Type
string
standaard latest
Description
ID van het model om te gebruiken. De beschikbare waarden zijn afhankelijk van model_type.
meshy-t2 (standaard, aanbevolen): het Smart Topology model — schonere topology, inheemse gescheiden delen, driehoekige output, en een gezichtsverdeling die je kunt instellen met target_polycount.
meshy-t1: het oude low-poly model; ondersteunt het instellen van een gezichtsverdeling met target_polycount niet.
Name
ultra_mode
Type
boolean
standaard false
Description
Schakelt Ultra-generatie in voor geometrie met hogere getrouwheid en fijnere oppervlaktedetails.
Alleen ondersteund wanneer ai_model is meshy-7 (of latest).
Name
should_texture
Type
boolean
standaard true
Description
Bepaal of texturen worden gegenereerd. Wanneer ingesteld op false, wordt de textuurfase overgeslagen, 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 (metaalachtig, ruwheid, normaal) naast de basiskleur. Een emissiekaart wordt ook inbegrepen wanneer ai_model is meshy-6, behalve bij texture_resolution: 8k. meshy-7 en latest produceren geen emissiekaart.
Name
texture_resolution
Type
string
standaard 2k
Description
Basiskleur textuurresolutie. Eén van 2k (2048×2048), 4k (4096×4096), of 8k (8192×8192). Hogere resoluties vangen meer oppervlakte detail.
4k en 8k zijn niet beschikbaar met ai_model: meshy-5. Bij 8k wordt geen emissiekaart geproduceerd.
Name
hd_texture
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik texture_resolution in plaats daarvan — gelijk aan texture_resolution: "4k". Wanneer beide zijn ingesteld, wordt texture_resolution de voorkeur gegeven.
Name
texture_prompt
Type
string
Description
Geef een tekstprompt om het textureringsproces te begeleiden. Maximaal 600 tekens.
Name
texture_image_url
Type
string
Description
Geef een 2D-afbeelding om het textureringsproces te begeleiden. We ondersteunen momenteel .jpg, .jpeg, en .png formaten.
Er zijn twee manieren om de afbeelding te leveren:
Publiek 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,<jouw base64-gecodeerde afbeeldingsgegevens>
Beeldtextuurering 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, zal texture_prompt standaard worden gebruikt om het model te textureren. Texturering via tekst of afbeelding kost 10 credits per taak.
Name
should_remesh
Type
boolean
standaard false (meshy-6, meshy-7), true (others)
Description
Beheert of de remesh-fase moet worden ingeschakeld. Voor het model van 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
Specificeer de topology van het gegenereerde model.
Beschikbare waarden:
quad: Genereer een quad-dominante mesh.
triangle: Genereer een gereduceerde driehoekige mesh.
Name
decimation_mode
Type
integer
Description
Activeer adaptieve decimatie door een polygonaantalniveau in te stellen. Wanneer ingesteld, wordt target_polycount genegeerd.
Beschikbare waarden:
1: Adaptief — ultra polygonaantal.
2: Adaptief — hoog polygonaantal.
3: Adaptief — medium 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 voltooid is.
Name
target_polycount
Type
integer
Description
Doel aantal polygonen (gezichten) in de output. Het werkelijke aantal kan afwijken van het doel afhankelijk van de geometrie.
target_polycount is van toepassing in twee onafhankelijke gevallen:
Remesh — met should_remesh: true op een standard model. De mesh wordt geremeshd (gereduceerd) tot ongeveer dit aantal. Bereik 100 tot 300.000, standaard 30.000. Als decimation_mode is ingesteld, heeft dit prioriteit en wordt target_polycount genegeerd.
Smart Topology — met model_type: smart-topology en ai_model: meshy-t2. Het model wordt direct op dit gezichtsverdeling gegenereerd; er wordt geen remesh uitgevoerd en should_remesh is niet vereist. Bereik 100 tot 15.000, standaard 4.000.
Name
symmetry_mode
Type
string
⚠ verouderd
standaard auto
Description
Verouderd. Deze parameter heeft geen invloed meer op de output.
Het symmetry_mode veld beheert 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: Dwingt symmetrie af tijdens de generatie.
Name
pose_mode
Type
string
standaard ""
Description
Specificeer de posemodus 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): Geen specifieke pose toegepast.
Name
is_a_t_pose
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik pose_mode in plaats daarvan. Of het model in een A/T-pose moet worden gegenereerd.
Name
image_enhancement
Type
boolean
standaard true
Description
Optimaliseert de inputafbeelding voor betere resultaten. Instellen op false behoudt het exacte uiterlijk van de inputafbeelding zonder enige stijlverwerking.
Alleen ondersteund wanneer ai_model is meshy-6, meshy-7, of latest.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert highlights en schaduwen van de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt onder aangepaste verlichting.
Alleen ondersteund wanneer ai_model is meshy-6.
Name
moderation
Type
boolean
standaard false
Description
Wanneer ingesteld op true, zal de invoerinhoud automatisch worden gescreend op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, zal de taak niet doorgaan naar generatie.
De inhoud van de image_url, texture_image_url, en texture_prompt invoeren zullen worden gescreend.
Name
target_formats
Type
string[]
Description
Geeft aan welke 3D-bestandsformaten in de output moeten worden opgenomen. Alleen de gevraagde formaten worden gegenereerd en geretourneerd, wat de voltooiingstijd van de taak kan verkorten. Wanneer weggelaten, worden alle ondersteunde formaten opgenomen.
Wanneer weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer expliciet gespecificeerd.
Name
auto_size
Type
boolean
standaard false
Description
Wanneer ingesteld op true, gebruikt de service AI vision om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig te schalen. De oorsprong wordt standaard ingesteld op bottom tenzij origin_at expliciet is ingesteld.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer ingesteld op true, rendert de taak daarnaast een transparante achtergrond (RGBA) versie van de preview 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 wijzen op de vooraanzicht, zodat bestaande clients niet worden beïnvloed.
Voegt ongeveer 3 seconden toe aan 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 result-eigenschap van de respons bevat het taak id van de nieuw aangemaakte Beeld naar 3D taak.
Foutmodi
Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
Ontbrekende parameter: Ofwel image_url of input_task_id moeten zijn verstrekt.
Ongeldige invoertaak: De input_task_id moet verwijzen naar een SUCCEEDED Tekst naar Afbeelding of Afbeelding naar Afbeelding taak die precies één afbeelding produceert.
Ongeldig afbeeldingsformaat: De verstrekte image_url is geen ondersteund formaat (.jpg, .jpeg, .png).
Onbereikbare URL: De image_url kon niet worden gedownload (404 of timeout).
Ongeldige Data URI: De base64-string is onjuist samengesteld.
Ongeldige parametercombinatie: enable_pbr wordt alleen ondersteund wanneer should_texture waar is.
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-3d
# Eenvoudig verzoek met vereiste parameterscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<je publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde Data URI>" }'# Met remesh, PBR, en A-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<je publiekelijk toegankelijke afbeeldingsurl of base64-gecodeerde Data URI>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Deze endpoint stelt je in staat om een Beeld naar 3D taak op te halen gegeven een geldig taak id.
Raadpleeg Het Beeld naar 3D Taak Object om te zien welke
eigenschappen zijn opgenomen in het Beeld naar 3D taakobject.
Parameters
Name
id
Type
path
Description
Unieke identificatie voor de Beeld naar 3D taak om op te halen.
Het Beeld naar 3D Taak object is een werkonderdeel dat Meshy bijhoudt om een 3D model te genereren vanuit een afbeelding input.
Het object heeft de volgende eigenschappen:
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie voor de taak. Hoewel we een k-sorteerbare UUID voor taak-ID's gebruiken als
implementatiedetail, moet je geen aannames doen over het formaat van het ID.
Name
type
Type
string
Description
Type van de Beeld naar 3D taak. De waarde is 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 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 is aangevraagd via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Downloadbare URL naar de originele GLB-output vóór remeshen.
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 het 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 transparante achtergrond (RGBA) versie van thumbnail_url. 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 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. Handig om het model vanuit meerdere hoeken in batchpipelines te bekijken 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 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
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 werd gebruikt om het textureringsproces te begeleiden.
Name
texture_image_url
Type
string
Description
Downloadbare URL naar de textuurafbeelding die werd gebruikt om het textureringsproces te begeleiden.
Name
ultra_mode
Type
boolean
Description
Geeft de ultra_mode waarde weer waarmee de taak is aangemaakt. Alleen aanwezig voor meshy-7-taken (of latest) die ultra_mode expliciet hebben ingesteld; anders weggelaten.
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 milliseconden 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 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, 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 basiskleurkaart afbeelding.
Name
metallic
Type
string
Description
Downloadbare URL naar de metallic map 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 map afbeelding.
Als de taak is aangemaakt met enable_pbr: false, of ai_model is meshy-5, meshy-7, of latest, zal deze eigenschap worden weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorgaande taken.
De waarde van dit veld is alleen betekenisvol 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 is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS, of SUCCEEDED is. Geeft 0 terug voor FAILED taken (credits worden terugbetaald bij een mislukking).