lowpoly avvecklas den 30 okt. 2026. Byt modell före dessa datum för att undvika fel i förfrågningar.
Retexture API
Retexture API är en funktion som låter dig integrera Meshys AI-drivna omtexturering 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.
Denna endpoint låter dig skapa en ny Retexture-uppgift. Se
The Retexture Task Object för att se vilka
egenskaper som ingår i Retexture-uppgiftsobjektet.
Uppgiften körs i bakgrunden. För information om hur lång tid det vanligtvis tar, se Processing Times.
Parametrar
Endast en av input_task_id eller model_url är obligatorisk. Om båda anges har input_task_id prioritet.
Name
input_task_id
Type
string
Obligatorisk
Description
ID:t för den slutförda Bild till 3D- eller Text till 3D-uppgiften du vill omtexturera.
Denna uppgift måste vara en av följande: Text till 3D Preview, Text till 3D Refine, Bild till 3D eller Remesh. Dessutom måste den ha statusen SUCCEEDED.
Name
model_url
Type
string
Obligatorisk
Description
Ange en 3D-modell för Meshy att texturera. Format som stöds: .glb, .gltf, .obj, .fbx, .stl.
Maximal filstorlek: 400 MB för en http- eller https-URL, 100 MB för en data:-URI.
En GLB-, glTF-, FBX- eller OBJ-fil över 100 MB kan ha som mest 10 000 000 polygoner. Polygoner räknas som trianglar: en fyrsidig polygon räknas som 2, och ett nät som ritas mer än en gång räknas en gång per kopia. Över 100 MB måste en FBX-fil vara binär FBX 7.1 eller nyare, och en GLB- eller glTF-fil får inte använda Draco-komprimering.
Det finns två sätt att ange modellen:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika internet.
Data URI: En base64-kodad data-URI för modellen. Använd MIME type application/octet-stream. Exempel: data:application/octet-stream;base64,<din base64-kodade modelldata>.
Exakt en stilinmatning krävs: text_style_prompt, image_style_url, eller multiview_image_urls. multiview_image_urls kan inte kombineras med någon av de andra två; om både text_style_prompt och image_style_url anges har image_style_url prioritet.
Name
text_style_prompt
Type
string
Obligatorisk
Description
Beskriv önskad texturstil för objektet med text. Maximalt 800 tecken.
Name
image_style_url
Type
string
Obligatorisk
Description
Ange en 2D-bild som vägledning för 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:
Publikt tillgänglig URL: En URL som är tillgänglig från det publika internet
Data URI: En base64-kodad data-URI för bilden. Exempel på en data-URI: data:image/jpeg;base64,<din base64-kodade bilddata>
Bildtexturering kanske inte fungerar optimalt om det finns betydande geometriska skillnader mellan originalassetet och den uppladdade bilden.
Name
multiview_image_urls
Type
string[]
Obligatorisk
Description
Ange 1 till 4 bilder som visar samma objekt från olika vyer för att vägleda textureringen. Den första bilden är primärvyn (framifrån); ordningen på de återstående vyerna (vänster, bak, höger) spelar ingen roll.
Varje element godtar samma format som image_style_url (en publikt tillgänglig URL eller en base64 data-URI, .jpg/.jpeg/.png/.webp).
Maximal filstorlek: 20 MB per bild.
Kräver ett explicit ai_model: "meshy-7".
Name
ai_model
Type
string
standard latest
Description
ID för den AI-modell som ska användas för omtexturering. Tillgängliga värden: meshy-6-lite, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
standard false
Description
Behåll modellens befintliga UV-layout istället för att generera en ny.
Om du omtexturerar en modell som Meshy har genererat (via input_task_id, eller en model_url som pekar på en Meshy-utdata), sätt detta till true för att återanvända dess optimerade UV-layout.
Om du omtexturerar en tredjepartsmodell du har laddat upp, sätt true när den redan har bra UV:er som du vill behålla, eller lämna det som false för att låta Meshy packa upp nya UV:er (bäst för modeller som saknar korrekt UV-mappning).
Name
enable_pbr
Type
boolean
standard false
Description
Generera PBR-mappar (metallic, roughness, normal) utöver basfärgen. En emissionsmapp inkluderas också när ai_model är meshy-6, förutom vid texture_resolution: 8k. meshy-6-lite, meshy-7 och latest producerar ingen emissionsmapp.
Name
texture_resolution
Type
string
standard 2k
Description
Upplösning för basfärgstextur. En av 2k (2048×2048), 4k (4096×4096), eller 8k (8192×8192). Högre upplösningar fångar mer ytdetalj.
4k och 8k kräver ai_modelmeshy-6, meshy-7 eller latest. Vid 8k produceras ingen emissionsmapp.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Använd texture_resolution istället — motsvarar texture_resolution: "4k". Om båda anges har texture_resolution företräde.
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.
Tillämpas endast när ai_model är meshy-6 och texture_resolution är 2k eller 4k. Med meshy-7 eller latest, samt vid 8k, accepteras den men ignoreras. Med meshy-6-lite returneras 400 om den skickas med något värde.
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 uppgiftens slutfö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 anges explicit.
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 förblir oförändrat.
Returvärden
Svarets result-egenskap innehåller id för den nyss skapade Retexture-uppgiften.
Felscenarier
Name
400 - Bad Request
Description
Begäran kunde inte godtas. Vanliga orsaker:
Saknad parameter: Antingen model_url eller input_task_id måste anges.
Saknad stil: En av text_style_prompt, image_style_url eller multiview_image_urls måste anges.
Motstridiga stilinmatningar: multiview_image_urls kan inte kombineras med text_style_prompt eller image_style_url.
Modell som inte stöds för flervy: multiview_image_urls kräver ett explicit ai_model: "meshy-7".
Modell inte tillgänglig: ai_model: "meshy-7" och ai_model: "meshy-6-lite" rullas ut gradvis och kanske inte är aktiverade för ditt konto ännu.
Ogiltig inmatningsuppgift: input_task_id måste hänvisa till en lyckad uppgift från en modell som stöds.
Ogiltigt modellformat: model_url pekar på en fil med ett filtillägg som inte stöds.
Oåtkomlig URL: model_url, image_style_url eller ett element i multiview_image_urls kunde inte hämtas.
Modellfil för stor: Filen i model_url överstiger 400 MB (http- eller https-URL) eller 100 MB (data:-URI).
För många polygoner: Filen i model_url är över 100 MB och har fler än 10 000 000 polygoner. Minska antalet polygoner och skicka filen igen.
ASCII-FBX över 100 MB: Filen i model_url är en ASCII-FBX över 100 MB. Skicka den som binär FBX eller GLB.
Oläsbar modellfil: Filen i model_url är över 100 MB och dess header kan inte läsas, till exempel en Draco-komprimerad GLB eller glTF, eller en binär FBX äldre än 7.1.
Modellheader för komplex: Filen i model_url är över 100 MB och dess header har för många nät, noder eller poster att kontrollera. Minska antalet objekt i filen och skicka den igen.
Bild för stor: Bilden i image_style_url eller ett element i multiview_image_urls överstiger 20 MB.
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.
Name
429 - Too Many Requests
Description
Du har överskridit din hastighetsgräns.
Request
POST
/openapi/v1/retexture
# Retexture with text promptcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style", "enable_original_uv": true, "enable_pbr": true }'# Retexture with image style and PBRcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "image_style_url": "<your publicly accessible image url or base64-encoded data URI>", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Denna endpoint låter dig hämta en Omtextureringsuppgift givet ett giltigt uppgifts-id.
Se The Retexture Task Object för att se vilka
egenskaper som ingår i Omtextureringsuppgiftens objekt.
Parametrar
Name
id
Type
path
Description
Unik identifierare för den Omtextureringsuppgift som ska hämtas.
Returnerar
Svaret innehåller Omtextureringsuppgiftens objekt. Se avsnittet
The Retexture Task Object för detaljer.
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?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=***" },"thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","texture_image_url":"","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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" } ],"task_error": {"message":"" },"consumed_credits":10}
Denna endpoint tar permanent bort en omtextureringsuppgift, 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 omtextureringsuppgift 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 kan inte återbetalas, 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 sluttillstånd (SUCCEEDED, FAILED eller CANCELED) tas bort
utan återbetalning.
Returnerar
Returnerar 200 OK vid lyckad borttagning, 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."}
[ {"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***" },"thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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" } ],"preceding_tasks":0,"task_error": {"message":"" },"consumed_credits":10 }]
Retexture Task-objektet är en arbetsenhet som Meshy använder för att generera en 3D-textur från antingen text- eller bildindata.
Modellen 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 Retexture-uppgift. Värdet är retexture.
Name
model_urls
Type
object
Description
Nedladdningsbar URL till den texturerade 3D-modellfilen som genererats av Meshy.
Name
glb
Type
string
Description
Nedladdningsbar URL till GLB-filen.
Name
fbx
Type
string
Description
Nedladdningsbar URL till FBX-filen.
Name
obj
Type
string
Description
Nedladdningsbar URL till OBJ-filen.
Name
usdz
Type
string
Description
Nedladdningsbar URL till USDZ-filen.
Name
mtl
Type
string
Description
Nedladdningsbar URL till MTL-filen, returneras tillsammans med OBJ-exporter när texturer finns.
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ärdes via target_formats.
Name
text_style_prompt
Type
string
Description
Detta är textprompten som användes för att skapa textureringsuppgiften.
Name
image_style_url
Type
string
Description
Detta är bildindatan som användes för att skapa textureringsuppgiften.
Name
multiview_image_urls
Type
string[]
Description
Nedladdningsbara URL:er till de flervy-referensbilder som användes för att skapa textureringsuppgiften. Finns endast med när uppgiften skapades med multiview_image_urls.
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örhandsgranskningen renderades framgångsrikt; annars utelämnas detta fält.
Name
progress
Type
integer
Description
Förlopp för uppgiften. Om uppgiften inte har startat ännu är detta värde 0. När uppgiften har lyckats blir detta 100.
Name
started_at
Type
timestamp
Description
Tidsstämpel för när uppgiften startades, i millisekunder. Om uppgiften inte har startat ännu är detta värde 0.
En tidsstämpel representerar antalet millisekunder som har förflutit sedan den 1 januari 1970 UTC, enligt
standarden RFC 3339.
Till exempel representeras fredagen den 1 september 2023, kl. 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
expires_at
Type
timestamp
Description
Tidsstämpel för när uppgiftens resultat upphör att gälla, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften slutfördes, i millisekunder. Om uppgiften inte är slutförd ännu är detta värde 0.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är ett av PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En array med textur-URL-objekt som genereras från uppgiften. Vanligtvis innehåller denna endast ett textur-URL-objekt. Varje textur-URL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till bilden för basfärgskartan.
Name
metallic
Type
string
Description
Nedladdningsbar URL till bilden för den metalliska kartan.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
normal
Type
string
Description
Nedladdningsbar URL till bilden för normalmappen.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
roughness
Type
string
Description
Nedladdningsbar URL till bilden för ojämnhetskartan.
Om uppgiften skapas med enable_pbr: false utelämnas denna egenskap.
Name
emission
Type
string
Description
Nedladdningsbar URL till bilden för emissionskartan.
Om uppgiften skapas med enable_pbr: false, med ai_model satt till meshy-6-lite, meshy-7 eller latest, eller med texture_resolution: 8k, utelämnas denna egenskap.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Denna egenskap finns endast med när uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Feldetaljer för misslyckade uppgifter. Se Fel för den fullständiga referensen för 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 Retexture Task Model
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***" },"text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","image_style_url":"https://assets.meshy.ai/***/image/example_image.jpg?Expires=***","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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" } ],"preceding_tasks":0,"task_error": {"message":"" },"consumed_credits":10}