lowpoly avvecklas den 30 okt. 2026. Byt modell före dessa datum för att undvika fel i förfrågningar.
Text till 3D API
Text till 3D API är en funktion som låter dig integrera Meshys Text till 3D-funktioner i din egen applikation. I det här avsnittet hittar du all information
du behöver för att komma igång med detta API.
Text till 3D använder ett arbetsflöde i två steg. Skapa först en preview-uppgift (mode: "preview") för att generera ett 3D-nät utan textur, så att du kan utvärdera formen. Skicka sedan den slutförda förhandsgranskningens uppgifts-ID till en refine-uppgift (mode: "refine") för att applicera textur på nätet. Båda stegen delar samma endpoint.
Denna endpoint skapar en Text till 3D-förhandsgranskningsuppgift, som genererar ett otexturerat 3D-nät (endast geometri) från en textprompt. Detta är det första steget i tvåstegsarbetsflödet. När förhandsgranskningen har lyckats, använd det returnerade uppgifts-ID:t för att skapa en refine-uppgift för texturering. Se
The Text to 3D Task Object för det fullständiga svarsschemat.
Uppgiften körs i bakgrunden. För information om hur lång tid det vanligtvis tar, se Processing Times.
Parametrar
Name
mode
Type
string
Obligatorisk
Description
Detta fält ska sättas till "preview" vid skapande av en förhandsgranskningsuppgift.
Name
prompt
Type
string
Obligatorisk
Description
Beskriv vilken typ av objekt 3D-modellen är. Max 800 tecken.
Name
model_type
Type
string
standard standard
Description
Ange typen av 3D-nätgenerering.
Tillgängliga värden:
standard: Vanlig 3D-nätgenerering med hög detaljnivå.
smart-topology: Välj en Smart Topology-modell med ai_model (meshy-t2 eller meshy-t2.5).
lowpoly (föråldrad, utfasas 30 oktober 2026): Genererar low-poly-nät optimerat för renare polygoner. Vi rekommenderar Meshy T2.5 istället: smart-topology med meshy-t2.5.
När smart-topology är valt ignoreras should_remesh och decimation_mode, och endast topology: triangle accepteras.
lowpoly kommer att fasas ut 30 oktober 2026. Efter det datumet kommer förfrågningar med model_type: "lowpoly" att returnera ett fel. Vi rekommenderar att byta till Meshy T2.5 (model_type: "smart-topology" med ai_model: "meshy-t2.5"). När lowpoly är valt ignoreras ai_model, topology, target_polycount och should_remesh.
Name
ai_model
Type
string
standard latest
Description
ID för modellen som ska användas. De tillgängliga värdena beror på model_type.
meshy-t2: Smart Topology-modellen — renare topology, naturligt separerade delar, triangelutmatning och ett antal ytor som du kan ställa in med target_polycount.
meshy-t2.5 (standard): Skarpare detaljer för spelassets. Triangelutmatning och ett antal ytor som du kan ställa in med target_polycount.
Name
geometry_resolution
Type
string
standard standard
Description
Genereringspass för geometri. 2k kör Ultra-passet på 2048³; 4k kör det på 4096³ för
finaste ytdetalj.
Tillgängliga värden: standard, 2k, 4k
Endast tillgängligt i preview-mode. Kräver meshy-7.1 eller latest.
standard false (Meshy 6 and Meshy 7 models), true (others)
Description
Styr om remesh-fasen ska aktiveras. För modellen med högst kvalitet rekommenderar vi att ställa in should_remesh till false.
Gäller endast när should_remesh = true
Name
topology
Type
string
standard triangle
Description
Ange topology för den genererade modellen.
Tillgängliga värden:
quad: Genererar ett nät som domineras av fyrhörningar (quad).
triangle: Genererar ett decimerat triangelnät.
Smart Topology-utmatning är endast triangelbaserad. Att begära quad tillsammans med ai_modelmeshy-t2 eller meshy-t2.5 returnerar ett fel.
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ställa in en polygonantal-nivå. När detta är inställt ignoreras target_polycount.
Tillgängliga värden:
1: Adaptiv — ultra polygonantal.
2: Adaptiv — högt polygonantal.
3: Adaptiv — medium polygonantal.
4: Adaptiv — lågt polygonantal.
Name
target_polycount
Type
integer
Description
Målvärde för antal polygoner (ytor) i utmatningen. Det faktiska antalet kan avvika från målvärdet beroende på geometrin.
target_polycount har effekt i två oberoende fall:
Remesh — med should_remesh: true på en standard-modell. Nätet remeshas (decimeras) till ungefär detta antal. Intervall 100 till 300 000, standard 30 000. Om decimation_mode är inställt har det prioritet och target_polycount ignoreras.
Smart Topology — med model_type: smart-topology och ai_modelmeshy-t2 eller meshy-t2.5. Modellen genereras direkt med detta antal ytor; ingen remesh körs och should_remesh krävs inte. För meshy-t2: intervall 100 till 15 000, standard 4 000. För meshy-t2.5: intervall 100 till 30 000, standard 15 000.
Name
symmetry_mode
Type
string
⚠ föråldrad
standard auto
Description
Föråldrad. Denna parameter påverkar inte längre utmatningen.
Fältet symmetry_mode styr symmetribeteendet under modellgenereringsprocessen.
De giltiga värdena är:
off: Inaktiverar symmetri.
auto: Avgör och tillämpar symmetri automatiskt baserat på indatageometrin.
on: Tvingar fram symmetri under generering.
Name
pose_mode
Type
string
standard ""
Description
Ange pose-mode för den genererade modellen.
Tillgängliga värden:
a-pose: Genererar modellen i en A-pose.
t-pose: Genererar modellen i en T-pose.
"" (tom sträng): Ingen specifik pose tillämpas.
Name
is_a_t_pose
Type
boolean
⚠ föråldrad
standard false
Description
Använd pose_mode istället. Om modellen ska genereras i en A/T-pose.
Name
art_style
Type
string
⚠ föråldrad
standard realistic
Description
Stöds inte av Meshy-6. Förfrågningar som använder Meshy-6 kommer att ignorera art_style, och vissa kombinationer kan orsaka fel. Tillgängliga värden: realistic, sculpture.
enable_pbr bör sättas till false vid användning av Sculpture-stil, eftersom Sculpture-stil genererar sin egen uppsättning PBR-mappar.
Name
moderation
Type
boolean
standard false
Description
När detta sätts till true kommer indatainnehållet automatiskt att granskas för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer uppgiften inte att fortsätta till generering.
Texten från prompt kommer att granskas.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska inkluderas i utmatningen. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska uppgiftens genomförandetid. Om parametern utelämnas inkluderas alla format som stöds.
Om parametern utelämnas genereras alla format utom 3mf. 3mf inkluderas endast när det uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När detta sätts till true renderar uppgiften dessutom en version av förhandsgranskningen med transparent bakgrund (RGBA) och returnerar den som alpha_thumbnail_url i GET-svaret. Det befintliga fältet thumbnail_url ändras inte.
Name
auto_size
Type
boolean
standard false
Description
När detta sätts till true använder tjänsten AI-synförmåga för att automatiskt uppskatta objektets verkliga höjd och ändra storlek på modellen i enlighet med detta. Origo kommer som standard att sättas till bottom om inte origin_at uttryckligen anges.
Gäller endast när auto_size = true
Name
origin_at
Type
string
standard bottom
Description
Origots position när auto_size är aktiverat.
Tillgängliga värden: bottom, center.
Returnerar
Svarets result-egenskap innehåller uppgifts-id:t för den nyskapade Text till 3D-uppgiften.
Felscenarier
Name
400 - Bad Request
Description
Förfrågan kunde inte godtas. Vanliga orsaker:
Saknad parameter: En obligatorisk parameter (t.ex. prompt, mode) saknas.
Ogiltig parameter: art_style är inte ett av de tillåtna värdena.
Prompten är för lång: prompt överskrider teckengränsen.
Modell som inte stöds för low poly: ai_model: "meshy-6-lite" stöder inte model_type: "lowpoly".
Modell som inte stöds för Ultra: geometry_resolution kräver meshy-7.1 eller latest.
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna uppgift.
Denna endpoint skapar en Text till 3D refine-task, som applicerar textur på ett färdigställt preview-nät. Du måste ange preview_task_id från en lyckad preview-task. Detta är det andra steget i det tvåstegsarbetsflödet.
Tasken körs i bakgrunden. För information om hur lång tid det vanligtvis tar, se Processing Times.
Parametrar
Name
mode
Type
string
Obligatorisk
Description
Detta fält ska sättas till "refine" när en refine-task skapas.
Name
preview_task_id
Type
string
Obligatorisk
Description
ID:t för motsvarande preview-task.
Statusen för den angivna preview-tasken måste vara SUCCEEDED.
Name
enable_pbr
Type
boolean
standard false
Description
Generera PBR-mappar (metallic, roughness, normal) utöver bas-färgen. En emission map inkluderas också när ai_model är meshy-6, förutom vid texture_resolution: 8k (ingen emission map genereras då). meshy-6-lite, meshy-7.1 och latest producerar ingen emission map, och inte heller en refine av en meshy-t2-preview som inte anger ai_model.
Name
texture_resolution
Type
string
standard 2k
Description
Upplösning för bas-färgstexturen. En av 2k (2048×2048), 4k (4096×4096), eller 8k (8192×8192). Högre upplösningar fångar mer ytdetalj. Gäller endast för refine-mode.
4k och 8k kräver ai_modelmeshy-6, meshy-7.1 eller latest. Vid 8k genereras ingen emission map.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Använd texture_resolution istället — motsvarar texture_resolution: "4k". När båda anges har texture_resolution företräde.
Name
texture_prompt
Type
string
Description
Ange en ytterligare textprompt för att styra texturerings processen. Max 800 tecken.
Name
texture_image_url
Type
string
Description
Ange en 2d-bild för att styra textureringsprocessen. Vi stöder för närvarande formaten .jpg, .jpeg, .png och .webp.
Maximal filstorlek: 20 MB.
Det finns två sätt att ange bilden på:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika internet
Data URI: En base64-kodad data URI av bilden. Exempel på en data URI: data:image/jpeg;base64,<your base64-encoded image data>
Bildtexturering kanske inte fungerar optimalt om det finns betydande geometriska skillnader mellan originalassetet och den uppladdade bilden. Endast en av texture_image_url eller texture_prompt kan användas för att styra textureringsprocessen. Om båda parametrarna anges kommer texture_prompt som standard att användas för att texturera modellen.
Utelämna denna parameter för att ärva modellen som användes av preview-tasken, vilket håller en preview och dess refine på samma modell genomgående. Ange ett explicit värde för att åsidosätta det arvet.
Ett explicit latest löses här på exakt samma sätt som på preview-tasken (för närvarande Meshy 7.1), så en latest-preview och dess latest-refine hamnar alltid på samma texturmodell.
Name
moderation
Type
boolean
standard false
Description
När detta sätts till true kommer indatainnehållet automatiskt att granskas för potentiellt skadligt innehåll. Om skadligt innehåll upptäcks kommer tasken inte att gå vidare till generering.
Både texten från texture_prompt och bilden från texture_image_url kommer att granskas.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort highlights och skuggor från bas-färgstexturen, vilket ger ett renare resultat som fungerar bättre med anpassade ljussättningar.
Har endast effekt när ai_model är meshy-6. meshy-7.1 och latest accepterar parametern men ignorerar den, liksom en refine av en meshy-t2-preview som inte anger ai_model. Om den anges tillsammans med meshy-6-lite returneras ett fel.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska inkluderas i utdata. Endast de begärda formaten genereras och returneras, vilket kan minska tasktens handläggningstid. När parametern utelämnas inkluderas alla format som stöds.
När parametern utelämnas genereras alla format utom 3mf. 3mf inkluderas endast när det uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När detta sätts till true renderar tasken dessutom en version av preview med transparent bakgrund (RGBA) och returnerar den som alpha_thumbnail_url i GET-svaret. Det befintliga fältet thumbnail_url förblir oförändrat.
Name
auto_size
Type
boolean
standard false
Description
När detta sätts till true använder tjänsten AI-synbaserad uppskattning för att automatiskt beräkna objektets verkliga höjd och ändra storlek på modellen i enlighet med detta. Origo sätts som standard till bottom om inte origin_at uttryckligen anges.
Gäller endast när auto_size = true
Name
origin_at
Type
string
standard bottom
Description
Origos position när auto_size är aktiverat.
Tillgängliga värden: bottom, center.
Returnerar
Svarets result-egenskap innehåller task-id:t för den nyligen skapade Text till 3D-tasken.
Felscenarier
Name
400 - Bad Request
Description
Begäran kunde inte accepteras. Vanliga orsaker:
Ogiltigt task-ID: preview_task_id är ogiltigt eller finns inte.
Task inte redo: Preview-tasken har ännu inte lyckats.
Modellmatchning saknas: Preview-taskens AI-modell är inkompatibel med den begärda refine-modellen.
Modell saknar stöd för remove_lighting: remove_lighting anges tillsammans med ai_model: "meshy-6-lite".
Name
401 - Unauthorized
Description
Autentiseringen misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckligt med credits för att utföra denna task.
Name
404 - Not Found
Description
Preview-tasken som anges av preview_task_id hittades inte.
Denna endpoint låter dig hämta en Text till 3D-uppgift givet ett giltigt uppgifts-id.
Se The Text to 3D Task Object för att se vilka
egenskaper som ingår i Text till 3D-uppgiftsobjektet.
Denna endpoint fungerar för både preview- och refine-uppgifter.
Parametrar
Name
id
Type
path
Description
Unik identifierare för den Text till 3D-uppgift som ska hämtas.
Denna endpoint tar permanent bort en Text till 3D-uppgift, inklusive alla tillhörande modeller och data. Denna åtgärd är oåterkallelig.
Sökvägsparametrar
Name
id
Type
path
Description
ID:t för den Text till 3D-uppgift som ska tas bort.
Uppgiftsstatus
En uppgift som fortfarande är PENDING tas bort och de credits som
förbrukades vid skapandet återbetalas.
En uppgift som redan är IN_PROGRESS kan inte tas bort: begäran avvisas
med 409 Conflict och uppgiften fortsätter att köras. Credits för en uppgift
som arbetaren redan har påbörjat är inte återbetalningsbara, så att ta bort den mitt i
körningen skulle kosta dig både krediterna och resultatet. Vänta tills den når
SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.
En uppgift i ett sluttillstånd (SUCCEEDED, FAILED eller CANCELED) tas bort
utan återbetalning.
Returnerar
Returnerar 200 OK vid lyckad begäran, eller 409 Conflict när uppgiften är
IN_PROGRESS.
// 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."}
Text to 3D Task-objektet är en arbetsenhet som Meshy håller reda på för att generera en 3D-modell från en text-indata. Det finns två steg i Text to 3D API:et, preview och refine. Preview-steget är till för att generera en 3D-modell med enbart nät, och refine-steget är till för att generera en texturerad 3D-modell baserad på resultatet från preview-steget.
Objektet har följande egenskaper:
Properties
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id som implementationsdetalj bör du inte göra några antaganden om id:ts format.
Name
type
Type
string
Description
Typ av Text to 3D-uppgift. Möjliga värden är text-to-3d-preview för uppgifter i preview-steget och text-to-3d-refine för uppgifter i refine-steget.
Name
model_urls
Type
object
Description
Nedladdningsbar URL till den texturerade 3D-modellfil som genererats av Meshy. Egenskapen för ett format utelämnas om formatet inte genererats, istället för att returnera en tom sträng.
Name
glb
Type
string
Description
Nedladdningsbar URL till GLB-filen.
Name
fbx
Type
string
Description
Nedladdningsbar URL till FBX-filen.
Name
usdz
Type
string
Description
Nedladdningsbar URL till USDZ-filen.
Name
obj
Type
string
Description
Nedladdningsbar URL till OBJ-filen.
Name
mtl
Type
string
Description
Nedladdningsbar URL till MTL-filen.
Name
stl
Type
string
Description
Nedladdningsbar URL till STL-filen.
Name
3mf
Type
string
Description
Nedladdningsbar URL till 3MF-filen. Visas endast när 3mf begärdes via target_formats.
Name
prompt
Type
string
Description
Detta är den omodifierade prompt som användes för att skapa uppgiften.
Name
negative_prompt
Type
string
⚠ föråldrad
Description
Behålls för bakåtkompatibilitet. Detta fält har ingen funktionell påverkan på genererade modeller.
Name
art_style
Type
string
⚠ föråldrad
Description
Den omodifierade art_style som användes för att skapa preview-uppgiften. Stöds inte av Meshy-6.
Name
texture_richness
Type
string
⚠ föråldrad
Description
Behålls för bakåtkompatibilitet. Detta fält har ingen funktionell påverkan på genererade modeller.
Name
texture_prompt
Type
string
Description
Ytterligare text-prompt som tillhandahålls för att styra textureringsprocessen under refine-steget.
Name
ultra_mode
Type
boolean
⚠ föråldrad
Description
Föråldrad; läs geometry_resolution istället.
Name
geometry_resolution
Type
string
Description
Den Ultra-nivå som preview-uppgiften kördes på (2k eller 4k); utelämnas för standard.
Name
texture_image_url
Type
string
Description
Nedladdningsbar URL till den texturbild som användes för att styra textureringsprocessen.
Name
thumbnail_url
Type
string
Description
Nedladdningsbar URL till miniatyrbilden av modellfilen.
Name
alpha_thumbnail_url
Type
string
Description
Nedladdningsbar URL till en version av thumbnail_url med transparent bakgrund (RGBA). Visas endast när uppgiften skapades med alpha_thumbnail: true och den transparenta förhandsvisningen renderades framgångsrikt; annars utelämnas detta fält.
Name
video_url
Type
string
⚠ föråldrad
Description
Nedladdningsbar URL till förhandsvisningsvideon. Kommer att tas bort i en framtida version.
Name
progress
Type
integer
Description
Förloppet för uppgiften. Om uppgiften ännu inte har startat kommer denna egenskap att vara 0. När uppgiften har lyckats blir den 100.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften ännu inte har startat kommer denna egenskap att vara 0.
En tidsstämpel representerar antalet millisekunder som förflutit sedan den 1 januari 1970 UTC, enligt
standarden RFC 3339.
Till exempel representeras fredagen den 1 september 2023 12:00:00 GMT som 1693569600000. Detta gäller
för alla tidsstämplar i Meshy API.
Name
created_at
Type
timestamp
Description
Tidsstämpel för när uppgiften skapades, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften avslutades, i millisekunder. Om uppgiften ännu inte är klar kommer denna egenskap att vara 0.
Name
status
Type
string
Description
Uppgiftens status. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En array med texture URL-objekt som genererats från uppgiften. Normalt innehåller denna bara ett texture URL-objekt. Varje texture URL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till bildfilen för baskulörkartan (base color map).
Name
metallic
Type
string
Description
Nedladdningsbar URL till bildfilen för den metalliska kartan.
Om uppgiften skapas med enable_pbr: false kommer denna egenskap att utelämnas.
Name
normal
Type
string
Description
Nedladdningsbar URL till bildfilen för normalmappen.
Om uppgiften skapas med enable_pbr: false kommer denna egenskap att utelämnas.
Name
roughness
Type
string
Description
Nedladdningsbar URL till bildfilen för ojämnhetskartan (roughness map).
Om uppgiften skapas med enable_pbr: false kommer denna egenskap att utelämnas.
Name
emission
Type
string
Description
Nedladdningsbar URL till bildfilen för emissionskartan.
Om uppgiften skapas med enable_pbr: false, om ai_model är meshy-6-lite, meshy-7.1 eller latest, eller om uppgiften refinerar en meshy-t2-preview utan att ange ai_model, kommer denna egenskap att utelämnas.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet i detta fält är endast meningsfullt om uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Fel för den fullständiga referensen till task_error-objektet.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Finns med när uppgiftens status är PENDING, IN_PROGRESS eller SUCCEEDED. Returnerar 0 för FAILED-uppgifter (credits återbetalas vid misslyckande).
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,"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}