Text till 3D API är en funktion som låter dig integrera Meshys Text till 3D-funktioner i din egen applikation. I detta avsnitt 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 det slutförda preview-uppgiftens task-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 preview-uppgift, som genererar ett texturlöst 3D-nät (endast geometri) från en text-prompt. Detta är det första steget i det tvåstegsarbetsflödet. När preview 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.
Parametrar
Name
mode
Type
string
Obligatorisk
Description
Detta fält ska sättas till "preview" när en preview-uppgift skapas.
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 högdetaljerad 3D-nätgenerering.
smart-topology: Välj Smart Topology-modellen med ai_model (meshy-t2).
lowpoly (föråldrad): Genererar low-poly-nät optimerat för renare polygoner. Vi rekommenderar att du använder smart-topology istället.
När smart-topology väljs ignoreras should_remesh och decimation_mode, och endast topology: triangle accepteras.
När lowpoly väljs 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. Tillgängliga värden beror på model_type.
meshy-t2 (standard): Smart Topology-modellen — renare topology, naturligt separerade delar, triangelutdata, och ett polygonantal du kan ställa in med target_polycount.
Name
geometry_resolution
Type
string
standard standard
Description
Geometrigenereringspass. 2k kör Ultra-passet vid 2048³; 4k kör det vid 4096³ för det
finaste ytdetaljerna.
Tillgängliga värden: standard, 2k, 4k
Stöds endast 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 sätta 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: Generera ett nät dominerat av quads.
triangle: Generera ett decimerat triangelnät.
Smart Topology-utdata är endast triangel. Att begära quad tillsammans med ai_model: meshy-t2 returnerar ett fel.
Name
decimation_mode
Type
integer
Description
Aktivera adaptiv decimering genom att ange en polygonantalsnivå. När detta anges ignoreras target_polycount.
Tillgängliga värden:
1: Adaptiv — ultrapolygonantal.
2: Adaptiv — högt polygonantal.
3: Adaptiv — medelhögt polygonantal.
4: Adaptiv — lågt polygonantal.
Name
target_polycount
Type
integer
Description
Målantal polygoner (ytor) i utdata. Det faktiska antalet kan avvika från målet beroende på geometrin.
target_polycount har effekt i två oberoende fall:
Remesh — med should_remesh: true på en standard-modell. Nätet remesh:as (decimeras) till ungefär detta antal. Intervall 100 till 300 000, standard 30 000. Om decimation_mode är angivet har det prioritet och target_polycount ignoreras.
Smart Topology — med model_type: smart-topology och ai_model: meshy-t2. Modellen genereras direkt med detta antal ytor; ingen remesh körs och should_remesh behövs inte. Intervall 100 till 15 000, standard 4 000.
Name
symmetry_mode
Type
string
⚠ föråldrad
standard auto
Description
Föråldrad. Denna parameter påverkar inte längre utdata.
Fältet symmetry_mode styr symmetribeteendet under modellgenereringsprocessen.
De giltiga värdena är:
off: Inaktiverar symmetri.
auto: Bestämmer och tillämpar automatiskt symmetri baserat på ingående geometri.
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: Generera modellen i en A-pose.
t-pose: Generera 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 ska sättas till false när Sculpture-stilen används, eftersom Sculpture-stilen genererar sina egna PBR-mappar.
Name
moderation
Type
boolean
standard false
Description
När detta sätts till true kommer innehå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 ingå i utdata. Endast de begärda formaten genereras och returneras, vilket kan minska tiden för att slutföra uppgiften. När detta utelämnas inkluderas alla format som stöds.
När detta 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örhandsvisningen 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-syn för att automatiskt uppskatta objektets verkliga höjd och ändra storlek på modellen därefter. 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.
Returer
Egenskapen result i svaret innehåller uppgifts-id för den nyligen skapade Text till 3D-uppgiften.
Felscenarion
Name
400 - Bad Request
Description
Förfrågan kunde inte accepteras. 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.
Prompt för lång: prompt överskrider teckengränsen.
Modell stöds inte för low poly: ai_model: "meshy-6-lite" stöder inte model_type: "lowpoly".
Modell stöds inte 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 tillämpar 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åstegs-arbetsflödet.
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
Motsvarande preview-task-id.
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 basfärgen. En emissionskarta inkluderas också när ai_model är meshy-6, förutom vid texture_resolution: 8k (då produceras ingen emissionskarta). meshy-6-lite, meshy-7.1 och latest producerar ingen emissionskarta.
Name
texture_resolution
Type
string
standard 2k
Description
Upplösning för basfärgstexturen. Antingen 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 produceras ingen emissionskarta.
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 teturbeläggningsprocessen. Max 800 tecken.
Name
texture_image_url
Type
string
Description
Ange en 2d-bild för att styra teturbeläggningsprocessen. Vi stöder för närvarande formaten .jpg, .jpeg och .png.
Det finns två sätt att ange bilden:
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,<din base64-kodade bilddata>
Bildtexturering kan fungera suboptimalt om det finns betydande geometriska skillnader mellan originaltillgången och den uppladdade bilden. Endast en av texture_image_url eller texture_prompt kan användas för att styra teturbeläggningsprocessen. Om båda parametrarna anges kommer texture_prompt som standard att användas för att textura 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 från start till slut. Skicka ett explicit värde för att åsidosätta detta arv.
Ett explicit latest löses här upp exakt som det gör för 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 satt till true kommer det inmatade innehå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 basfärgstexturen, vilket ger ett renare resultat som fungerar bättre med anpassade ljussättningar.
Har endast effekt när ai_model är meshy-6; andra modeller ignorerar detta.
Name
target_formats
Type
string[]
Description
Anger vilka 3D-filformat som ska inkluderas i resultatet. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska tiden för att slutföra tasken. Om parametern utelämnas inkluderas alla stödda format.
Om parametern utelämnas genereras alla format förutom 3mf. 3mf inkluderas endast när det anges explicit.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När satt till true renderar tasken dessutom en version av förhandsvisningen 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 satt till true använder tjänsten AI-syn för att automatiskt uppskatta objektets verkliga höjd och ändra storlek på modellen därefter. Origo kommer att sättas till bottom som standard om inte origin_at anges explicit.
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.
Returvärden
Egenskapen result i svaret innehåller task-id för den nyskapade Text till 3D-tasken.
Felläge
Name
400 - Bad Request
Description
Begäran var inte godtagbar. Vanliga orsaker:
Ogiltigt task-ID: preview_task_id är ogiltigt eller finns inte.
Task inte redo: Preview-tasken har ännu inte lyckats.
Modellmissmatchning: Preview-taskens AI-modell är inkompatibel med den begärda refine-modellen.
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 angavs med 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.
Detta endpoint tar permanent bort en Text till 3D-uppgift, inklusive alla tillhörande modeller och data. Denna åtgärd kan inte ångras.
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: förfrågan
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 credits och resultatet. Vänta tills den når
SUCCEEDED, FAILED eller CANCELED, och ta sedan bort den.
En uppgift i ett slutgiltigt tillstånd (SUCCEEDED, FAILED eller CANCELED) tas bort
utan återbetalning.
Returer
Returnerar 200 OK vid framgång, 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 till 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 till 3D API:et, preview och refine. Preview-steget används för att generera en 3D-modell med enbart nät, och refine-steget används 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 ett k-sorterbart 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 till 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-modellfilen 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. Finns endast med när 3mf begärts 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
Bibehå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
Bibehålls för bakåtkompatibilitet. Detta fält har ingen funktionell påverkan på genererade modeller.
Name
texture_prompt
Type
string
Description
Ytterligare textprompt 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
Ultra-nivån som preview-uppgiften kördes i (2k eller 4k); utelämnas för standard.
Name
texture_image_url
Type
string
Description
Nedladdningsbar URL till texturbilden 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). Finns endast med när uppgiften skapades med alpha_thumbnail: true och den transparenta förhandsvisningen renderades utan problem; 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
Uppgiftens progress. 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 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 slutfördes, i millisekunder. Om uppgiften ännu inte är slutförd 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 av texture URL-objekt som genereras från uppgiften. Vanligtvis 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ör (base color).
Name
metallic
Type
string
Description
Nedladdningsbar URL till bildfilen för metallic map.
Om uppgiften skapades med enable_pbr: false utelämnas denna egenskap.
Name
normal
Type
string
Description
Nedladdningsbar URL till bildfilen för normalmap.
Om uppgiften skapades med enable_pbr: false utelämnas denna egenskap.
Name
roughness
Type
string
Description
Nedladdningsbar URL till bildfilen för roughness map.
Om uppgiften skapades med enable_pbr: false utelämnas denna egenskap.
Name
emission
Type
string
Description
Nedladdningsbar URL till bildfilen för emission map.
Om uppgiften skapades med enable_pbr: false, eller om ai_model är meshy-6-lite, utelämnas denna egenskap.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Värdet av 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 hela referensen av 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}