Tekst naar 3D API is een functie waarmee je de Tekst naar 3D-mogelijkheden van Meshy in je eigen applicatie kunt integreren. In deze sectie vind je alle informatie
die je nodig hebt om met deze API aan de slag te gaan.
Tekst naar 3D gebruikt een workflow in twee stappen. Maak eerst een previewtaak (mode: "preview") om een 3D-mesh zonder textuur te genereren, zodat je de vorm kunt beoordelen. Geef vervolgens de taak-ID van de voltooide preview door aan een verfijningstaak (mode: "refine") om textuur op de mesh toe te passen. Beide stappen gebruiken hetzelfde endpoint.
Deze endpoint maakt een Tekst naar 3D-previewtaak aan, die een 3D-mesh zonder textures (alleen geometrie) genereert op basis van een tekstprompt. Dit is de eerste stap van de tweestapsworkflow. Zodra de preview is geslaagd, gebruikt u de geretourneerde taak-ID om een verfijningstaak te maken voor het toevoegen van textures. Raadpleeg
Het Tekst naar 3D-taakobject voor het volledige responseschema.
Parameters
Name
mode
Type
string
Verplicht
Description
Dit veld moet worden ingesteld op "preview" bij het maken van een previewtaak.
Name
prompt
Type
string
Verplicht
Description
Beschrijf wat voor soort object het 3D-model is. Maximaal 600 tekens.
Name
model_type
Type
string
standaard standard
Description
Geef het type 3D-meshgeneratie op.
Beschikbare waarden:
standard: Reguliere 3D-meshgeneratie met veel detail.
lowpoly: Genereert een low-poly mesh die is geoptimaliseerd voor schonere polygonen.
Wanneer lowpoly is geselecteerd, worden ai_model, topology, target_polycount, should_remesh genegeerd.
Name
ai_model
Type
string
standaard latest
Description
ID van het te gebruiken model. Beschikbare waarden: meshy-5, meshy-6, latest (Meshy 6).
Name
should_remesh
Type
boolean
standaard false (meshy-6), true (others)
Description
Bepaalt of de remesh-fase wordt ingeschakeld. Wanneer ingesteld op false, retourneert de API direct de driehoekige mesh met de hoogste precisie.
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 mesh die voornamelijk uit quads bestaat.
triangle: Genereer een gedecimeerde driehoekige mesh.
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 waardebereik 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 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
symmetry_mode
Type
string
⚠ verouderd
standaard auto
Description
Verouderd (deprecated). Deze parameter heeft geen invloed meer op de uitvoer.
Het veld symmetry_mode bepaalt 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
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
art_style
Type
string
⚠ verouderd
standaard realistic
Description
Niet ondersteund door Meshy-6. Verzoeken die Meshy-6 gebruiken, negeren art_style, en sommige combinaties kunnen fouten veroorzaken. Beschikbare waarden: realistic, sculpture.
enable_pbr moet worden ingesteld op false bij gebruik van de Sculpture-stijl, omdat de Sculpture-stijl een eigen set PBR-maps genereert.
Name
moderation
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de invoerinhoud automatisch gescreend op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet door naar generatie.
De tekst uit prompt wordt gescreend.
Name
target_formats
Type
string[]
Description
Geeft aan welke 3D-bestandsindelingen in de uitvoer moeten worden opgenomen. Alleen de aangevraagde indelingen worden gegenereerd en geretourneerd, wat de voltooiingstijd van de taak kan verkorten. Wanneer dit wordt weggelaten, worden alle ondersteunde indelingen opgenomen.
Wanneer dit wordt weggelaten, worden alle indelingen behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer dit expliciet is opgegeven.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer ingesteld op true, 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
auto_size
Type
boolean
standaard false
Description
Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het formaat van het model dienovereenkomstig te wijzigen. De oorsprong wordt standaard bottom, tenzij origin_at expliciet is ingesteld.
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.
Retourneert
De eigenschap result van de respons bevat de taak-id van de nieuw gemaakte Tekst naar 3D-taak.
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was niet acceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: Een vereiste parameter (bijv. prompt, mode) ontbreekt.
Ongeldige parameter: art_style is niet een van de toegestane waarden.
Prompt te lang: De prompt overschrijdt de tekenlimiet.
Deze endpoint maakt een Tekst naar 3D-verfijningstaak, die textuur toepast op een voltooide preview-mesh. Je moet de preview_task_id van een geslaagde previewtaak opgeven. Dit is de tweede stap van de tweestapsworkflow.
Parameters
Name
mode
Type
string
Verplicht
Description
Dit veld moet worden ingesteld op "refine" bij het maken van een verfijningstaak.
Name
preview_task_id
Type
string
Verplicht
Description
De bijbehorende previewtaak-id.
De status van de opgegeven previewtaak moet SUCCEEDED zijn.
Name
enable_pbr
Type
boolean
standaard false
Description
Genereer PBR-maps (metallic, roughness, normal) naast de basiskleur. Een emissiemap wordt ook opgenomen wanneer ai_modelmeshy-6 of latest is.
Name
hd_texture
Type
boolean
standaard false
Description
Genereer de basiskleurtextuur met 4K-resolutie (4096×4096) voor meer detail.
Alleen ondersteund wanneer ai_modelmeshy-6 of latest is. PBR-maps worden altijd op 2K gegenereerd.
Name
texture_prompt
Type
string
Description
Geef een aanvullende tekstprompt op om het textureringsproces te sturen. Maximaal 600 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:
Openbaar 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 geometrieverschillen zijn tussen de oorspronkelijke asset en de geüploade afbeelding. Slechts één van texture_image_url of texture_prompt mag worden gebruikt om het textureringsproces te sturen. Als beide parameters worden opgegeven, wordt texture_prompt standaard gebruikt om het model te textureren.
Name
ai_model
Type
string
standaard latest
Description
ID van het model dat moet worden gebruikt voor verfijning. Beschikbare waarden: meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
standaard false
Description
Wanneer ingesteld op true, wordt de invoerinhoud automatisch gescreend op mogelijk schadelijke inhoud. Als schadelijke inhoud wordt gedetecteerd, gaat de taak niet door naar generatie.
Zowel de tekst uit texture_prompt als de afbeelding uit texture_image_url wordt gescreend.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert highlights en schaduwen uit de basiskleurtextuur, waardoor een schoner resultaat ontstaat dat beter werkt onder aangepaste belichtingsopstellingen.
Alleen ondersteund wanneer ai_modelmeshy-6 of latest is.
Name
target_formats
Type
string[]
Description
Geeft aan welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de aangevraagde formaten worden gegenereerd en geretourneerd, wat de voltooiingstijd 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 dit expliciet is opgegeven.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer ingesteld op true, rendert de taak daarnaast 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
auto_size
Type
boolean
standaard false
Description
Wanneer ingesteld op true, gebruikt de service AI-visie om automatisch de werkelijke hoogte van het object te schatten en het model dienovereenkomstig van formaat te wijzigen. De oorsprong wordt standaard ingesteld op bottom, tenzij origin_at expliciet is ingesteld.
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.
Retourneert
De eigenschap result van de respons bevat de taak-id van de nieuw gemaakte Tekst naar 3D-taak.
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was niet acceptabel. Veelvoorkomende oorzaken:
Ongeldige taak-ID: De preview_task_id is ongeldig of bestaat niet.
Taak niet gereed: De previewtaak is nog niet geslaagd.
Model komt niet overeen: Het AI-model van de previewtaak is incompatibel met het aangevraagde verfijningsmodel.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
404 - Not Found
Description
De previewtaak die is opgegeven door preview_task_id is niet gevonden.
Met deze endpoint kun je een Tekst naar 3D-taak ophalen op basis van een geldige taak-id.
Raadpleeg Het Tekst naar 3D-taakobject om te zien welke
eigenschappen zijn opgenomen in het Tekst naar 3D-taakobject.
Deze endpoint werkt voor zowel preview- als verfijntaken.
Parameters
Name
id
Type
path
Description
Unieke identifier voor de Tekst naar 3D-taak die moet worden opgehaald.
Het Tekst naar 3D-taakobject is een werkeenheid die Meshy bijhoudt om een 3D-model te genereren op basis van tekstinvoer. Er zijn twee fasen van de Tekst naar 3D-API: preview en refine. De previewfase is bedoeld voor het genereren van een 3D-model met alleen een mesh, en de verfijningsfase is bedoeld voor het genereren van een 3D-model met texture op basis van het resultaat van de previewfase.
Het object heeft de volgende eigenschappen:
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we een k-sorteerbare UUID voor taak-id's gebruiken als
implementatiedetail, moet je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de Tekst naar 3D-taak. Mogelijke waarden zijn text-to-3d-preview voor taken in de previewfase en text-to-3d-refine voor taken in de verfijningsfase.
Name
model_urls
Type
object
Description
Downloadbare URL naar het getextureerde 3D-modelbestand dat door Meshy is gegenereerd. De eigenschap voor een indeling wordt weggelaten als de indeling niet wordt gegenereerd, in plaats van een lege string te retourneren.
Name
glb
Type
string
Description
Downloadbare URL naar het GLB-bestand.
Name
fbx
Type
string
Description
Downloadbare URL naar het FBX-bestand.
Name
usdz
Type
string
Description
Downloadbare URL naar het USDZ-bestand.
Name
obj
Type
string
Description
Downloadbare URL naar het OBJ-bestand.
Name
mtl
Type
string
Description
Downloadbare URL naar het MTL-bestand.
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
prompt
Type
string
Description
Dit is de ongewijzigde prompt die is gebruikt om de taak aan te maken.
Name
negative_prompt
Type
string
⚠ verouderd
Description
Behouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele impact op gegenereerde modellen.
Name
art_style
Type
string
⚠ verouderd
Description
De ongewijzigde art_style die is gebruikt om de previewtaak aan te maken. Niet ondersteund door Meshy-6.
Name
texture_richness
Type
string
⚠ verouderd
Description
Behouden voor achterwaartse compatibiliteit. Dit veld heeft geen functionele impact op gegenereerde modellen.
Name
texture_prompt
Type
string
Description
Aanvullende tekstprompt die wordt verstrekt om het textureringsproces tijdens de verfijningsfase te sturen.
Name
texture_image_url
Type
string
Description
Downloadbare URL naar de textuurafbeelding die is gebruikt om het textureringsproces te sturen.
Name
thumbnail_url
Type
string
Description
Downloadbare URL naar de thumbnail-afbeelding van het modelbestand.
Name
alpha_thumbnail_url
Type
string
Description
Downloadbare URL naar een versie met transparante achtergrond (RGBA) 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
video_url
Type
string
⚠ verouderd
Description
Downloadbare URL naar de previewvideo. Wordt verwijderd in een toekomstige release.
Name
progress
Type
integer
Description
progress 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 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
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 uit de taak worden 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 ai_model is meshy-5, wordt deze eigenschap weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande 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. Retourneert 0 voor FAILED-taken (credits worden terugbetaald bij mislukking).
Example Text to 3D Task Object
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"text-to-3d-preview","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=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"prompt":"a monster mask","texture_prompt":"green slimy skin with scales and warts","texture_image_url":"","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"seed":1234,"started_at":1692771667037,"created_at":1692771650657,"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":20}