Afbeelding naar 3D API is een functie waarmee je de 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.
Met deze endpoint kunt u een nieuwe Afbeelding naar 3D-taak aanmaken. Raadpleeg
Het Afbeelding naar 3D-taakobject om te zien welke
eigenschappen zijn opgenomen in het Afbeelding naar 3D-taakobject.
Parameters
Slechts één van input_task_id of image_url is verplicht. Als beide worden opgegeven, heeft input_task_id voorrang.
Name
input_task_id
Type
string
Verplicht
Description
De ID van een voltooide afbeeldingsgeneratietaak waarvan de uitvoer moet worden gebruikt als invoerafbeelding. 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
Geef een afbeelding op die Meshy kan gebruiken bij het maken van het model. We ondersteunen momenteel de formaten .jpg, .jpeg en .png.
Er zijn twee manieren om de afbeelding op te geven:
Publiek toegankelijke URL: Een URL die vanaf het openbare internet toegankelijk is.
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
model_type
Type
string
standaard standard
Description
Geef het type 3D mesh-generatie op.
Beschikbare waarden:
standard: Reguliere 3D mesh-generatie met veel detail.
smart-topology: Kies een Smart Topology-model met ai_model (meshy-t2).
lowpoly (verouderd): Genereert een low-poly mesh geoptimaliseerd voor schonere polygonen. We raden aan om in plaats daarvan 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 te gebruiken model. De beschikbare waarden zijn afhankelijk van model_type.
meshy-t2 (standaard): het Smart Topology-model — schonere topology, van nature gescheiden onderdelen, driehoeksuitvoer en een polygoonaantal dat u kunt instellen met target_polycount.
Name
ultra_mode
Type
boolean
standaard false
Description
Schakelt Ultra-generatie in voor geometrie van hogere getrouwheid met fijner oppervlaktedetail.
Alleen ondersteund wanneer ai_modelmeshy-7 (of latest) is.
Name
should_texture
Type
boolean
standaard true
Description
Bepaalt of textures worden gegenereerd. Door dit op false te zetten wordt de texturefase overgeslagen, wat resulteert in een mesh zonder textures.
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_modelmeshy-6 is, behalve bij texture_resolution: 8k. meshy-7 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 zijn niet beschikbaar bij ai_model: meshy-5. Bij 8k wordt 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 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 en .png.
Er zijn twee manieren om de afbeelding op te geven:
Publiek toegankelijke URL: Een URL die vanaf het openbare internet toegankelijk is
Data URI: Een base64-gecodeerde data URI van de afbeelding. Voorbeeld van een data URI: data:image/jpeg;base64,<your base64-encoded image data>
Het textureren met een afbeelding werkt mogelijk niet optimaal als er substantiële geometrieverschillen zijn tussen de 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. Textureren via tekst of afbeelding kost 10 credits per taak.
Name
should_remesh
Type
boolean
standaard false (meshy-6, meshy-7), true (others)
Description
Bepaalt of de remeshfase wordt ingeschakeld. Voor het model van de hoogste kwaliteit raden we aan om 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 overwegend uit vierhoeken bestaande mesh.
triangle: Genereer een gedecimeerde driehoeksmesh.
Name
decimation_mode
Type
integer
Description
Schakel adaptieve decimatie in door een polygoonaantal-niveau in te stellen. Wanneer dit is ingesteld, wordt target_polycount genegeerd.
Beschikbare waarden:
1: Adaptief — ultrahoog 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 staat, slaat Meshy ook een extra GLB-bestand op voordat de remeshfase is voltooid.
Name
target_polycount
Type
integer
Description
Beoogd aantal polygonen (vlakken) in de uitvoer. Het werkelijke aantal kan afwijken van het doel, afhankelijk van de geometrie.
target_polycount werkt in twee onafhankelijke gevallen:
Remesh — met should_remesh: true op een standard-model. De mesh wordt geremesht (gedecimeerd) tot ongeveer dit aantal. Bereik 100 tot 300.000, standaard 30.000. Als decimation_mode is ingesteld, heeft dit voorrang en wordt target_polycount genegeerd.
Smart Topology — met model_type: smart-topology en ai_model: meshy-t2. Het model wordt direct gegenereerd met dit aantal vlakken; 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 uitvoer.
Het veld symmetry_mode bepaalt het symmetriegedrag tijdens het genereren van het model.
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 het genereren.
Name
pose_mode
Type
string
standaard ""
Description
Geef de pose-mode voor het gegenereerde model op.
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 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 invoerafbeelding voor betere resultaten. Zet dit op false om het exacte uiterlijk van de invoerafbeelding te behouden zonder stijlverwerking.
Alleen ondersteund wanneer ai_modelmeshy-6, meshy-7 of latest is.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert lichtpunten en schaduwen uit de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt bij aangepaste belichtingsopstellingen.
Alleen ondersteund wanneer ai_modelmeshy-6 is.
Name
moderation
Type
boolean
standaard false
Description
Wanneer dit op true staat, wordt de invoerinhoud automatisch gecontroleerd op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet verder met genereren.
De inhoud van de invoer image_url, texture_image_url en texture_prompt wordt gecontroleerd.
Name
target_formats
Type
string[]
Description
Geeft aan welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de gevraagde formaten worden gegenereerd en geretourneerd, wat de doorlooptijd van de taak kan verkorten. Wanneer dit wordt weggelaten, worden alle ondersteunde formaten opgenomen.
Wanneer dit wordt weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer expliciet opgegeven.
Name
auto_size
Type
boolean
standaard false
Description
Wanneer dit op true staat, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object in te schatten en het model dienovereenkomstig van formaat te wijzigen. De oorsprong staat standaard op bottom, tenzij origin_at expliciet is ingesteld.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer dit op true staat, rendert de taak ook 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 staat, rendert de taak ook vier hoofdaanzichten (voor, rechts, achter, links) en retourneert deze onder thumbnail_urls in de GET-respons. Het bestaande veld thumbnail_url blijft ongewijzigd en verwijst nog steeds naar het vooraanzicht, zodat bestaande clients hier geen last van hebben.
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.
Retourwaarden
De eigenschap result van de respons bevat de taak-id van de nieuw aangemaakte Afbeelding naar 3D-taak.
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:
Ontbrekende parameter: Er moet ofwel image_url ofwel input_task_id worden opgegeven.
Ongeldige invoertaak: input_task_id moet verwijzen naar een SUCCEEDED Tekst naar afbeelding- of Afbeelding naar afbeelding-taak die precies één afbeelding oplevert.
Ongeldig afbeeldingsformaat: De opgegeven image_url heeft 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 opgemaakt.
Ongeldige parametercombinatie: enable_pbr wordt alleen ondersteund wanneer should_texture waar (true) is.
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/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With remesh, PBR, and 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": "<your publicly accessible image url or base64-encoded 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 Afbeelding naar 3D taak op te halen met een geldig taak id.
Raadpleeg Het Afbeelding naar 3D Taak Object om te zien welke
eigenschappen zijn opgenomen in het Afbeelding naar 3D taak object.
Parameters
Name
id
Type
path
Description
Unieke identificatie voor de Afbeelding naar 3D taak om op te halen.
Het Afbeelding naar 3D Taakobject is een werkunit die Meshy bijhoudt om een 3D-model te genereren vanuit een afbeelding invoer.
Het object heeft de volgende eigenschappen:
Eigenschappen
Name
id
Type
string
Description
Unieke identificatie voor de taak. Hoewel we een k-sortable UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames maken over het formaat van de id.
Name
type
Type
string
Description
Type van de Afbeelding naar 3D taak. De waarde is image-to-3d.
Name
model_urls
Type
object
Description
Downloadbare URL naar het getextureerde 3D-modelbestand gegenereerd door Meshy. 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-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 aangevraagd via target_formats.
Name
pre_remeshed_glb
Type
string
Description
Downloadbare URL naar de originele GLB-uitvoer vóór remeshing.
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. Equivalent aan thumbnail_urls.front wanneer aanwezig, behouden 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 kardinale-weergave thumbnails 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 voor het bekijken van het model vanuit meerdere hoeken in batch-pijplijnen 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
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
Weergeeft de ultra_mode waarde waarmee de taak is aangemaakt. Alleen aanwezig voor meshy-7 (of latest) taken die expliciet ultra_mode 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, 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, zal deze eigenschap 0 zijn.
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
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 vanuit 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 basis kleurkaart afbeelding.
Name
metallic
Type
string
Description
Downloadbare URL naar de metallic kaart 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 kaart afbeelding.
Als de taak is aangemaakt met enable_pbr: false, wordt deze eigenschap weggelaten.
Name
emission
Type
string
Description
Downloadbare URL naar de emissie kaart afbeelding.
Als de taak is aangemaakt met enable_pbr: false, of ai_model is meshy-5, meshy-7, of latest, wordt deze eigenschap 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 mislukking).