Retexture API är en funktion som låter dig integrera Meshys AI-förmågor för omtexturering i din egen applikation. I detta avsnitt hittar du all information du behöver för att komma igång med detta API.
Detta endpoint tillåter dig att skapa en ny Omtextureringsuppgift. Se Omtextureringsuppgiftsobjektet för att se vilka egenskaper som ingår i Omtextureringsuppgiftsobjektet.
Parametrar
Endast en av input_task_id eller model_url är krävd. Om båda ges, tar input_task_id prioritet.
Name
input_task_id
Type
string
Obligatorisk
Description
ID för den slutförda Bild till 3D eller Text till 3D-uppgift du vill omtexturera. Denna uppgift måste vara en av följande uppgifter: Text till 3D Förhandsvisning, Text till 3D Förfina, Bild till 3D eller Remesh. Dessutom måste den ha statusen SUCCEEDED.
Name
model_url
Type
string
Obligatorisk
Description
Tillhandahåll en 3D-modell för Meshy att texturera. Stödda format: .glb, .gltf, .obj, .fbx, .stl.
Det finns två sätt att tillhandahålla modellen:
Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga internet.
Data URI: En base64-kodad data URI av modellen. Använd MIME-type application/octet-stream. Exempel: data:application/octet-stream;base64,<your base64-encoded model data>.
Exakt en stilinmatning är krävd: text_style_prompt, image_style_url, eller multiview_image_urls. multiview_image_urls kan inte kombineras med något av de andra två; om både text_style_prompt och image_style_url tillhandahålls, tar image_style_url prioritet.
Name
text_style_prompt
Type
string
Obligatorisk
Description
Beskriv ditt önskade texturstil på objektet med text. Max 600 tecken.
Name
image_style_url
Type
string
Obligatorisk
Description
Tillhandahåll en 2D-bild för att vägleda textureringsprocessen. Vi stöder för närvarande .jpg, .jpeg, och .png format.
Det finns två sätt att tillhandahålla bilden:
Offentligt tillgänglig URL: En URL som är tillgänglig från det offentliga 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 geometri skillnader mellan den ursprungliga uppgiften och den uppladdade bilden.
Name
multiview_image_urls
Type
string[]
Obligatorisk
Description
Tillhandahåll 1 till 4 bilder som visar samma objekt ur olika vyer för att vägleda textureringen. Den första bilden är den primära (främre) vyn; ordningen på de återstående vyerna (vänster, bak, höger) spelar ingen roll.
Varje element accepterar samma format som image_style_url (en offentligt tillgänglig URL eller en base64 data URI, .jpg/.jpeg/.png).
Kräver ai_model: "meshy-7" (eller latest).
Name
ai_model
Type
string
standard latest
Description
ID för AI-modellen att använda för omtexturering. Tillgängliga värden: meshy-5, 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 genererat (via input_task_id, eller en model_url som pekar på en Meshy-utgång), sätt detta till true för att återanvända dess optimerade UV-layout.
Om du omtexturerar en tredjepartsmodell du laddat upp, sätt true när den redan har bra UVs du vill behålla, eller lämna det som false för att låta Meshy avtäcka nya UVs (bäst för modeller som saknar korrekt UV-mappning).
Name
enable_pbr
Type
boolean
standard false
Description
Generera PBR-mappar (metallic, rugghet, normal) utöver grundfärgen. En emissionskarta ingår också när ai_model är meshy-6, förutom vid texture_resolution: 8k. meshy-7 och latest producerar inte en emissionskarta.
Name
texture_resolution
Type
string
standard 2k
Description
Grundfärg textur upplösning. 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 emissionskarta.
Name
hd_texture
Type
boolean
⚠ föråldrad
standard false
Description
Använd texture_resolution istället — motsvarande texture_resolution: "4k". När båda är inställda, har texture_resolution företräde.
Name
remove_lighting
Type
boolean
standard true
Description
Tar bort höjdpunkter och skuggor från grundfärg texturen, vilket ger ett renare resultat som fungerar bättre under anpassade belysningsinställningar.
Endast stöds när ai_model är meshy-6.
Name
target_formats
Type
string[]
Description
Specificerar vilka 3D-filformat som ska inkluderas i utgången. Endast de begärda formaten kommer att genereras och returneras, vilket kan minska uppgiftenstidsåtgång. När utelämnats, inkluderas alla stödda format.
När utelämnats, genereras alla format utom 3mf. 3mf inkluderas endast när det uttryckligen anges.
Name
alpha_thumbnail
Type
boolean
standard false
Description
När det är inställt på true, renderar uppgiften dessutom en transparent-bakgrund (RGBA) version av förhandsgranskningen och returnerar den som alpha_thumbnail_url på GET-svaret. Det befintliga thumbnail_url-fältet är oförändrat.
Returnerar
resultat-egenskapen av svaret innehåller uppgiftens id för den nyss skapade Omtextureringsuppgiften.
Felkoder
Name
400 - Bad Request
Description
Begäran var oacceptabel. Vanliga orsaker:
Saknad parameter: Antingen model_url eller input_task_id måste tillhandahållas.
Saknad stil: En av text_style_prompt, image_style_url eller multiview_image_urls måste tillhandahållas.
Konflikterande stilingångar: multiview_image_urls kan inte kombineras med text_style_prompt eller image_style_url.
Modell som inte stöds för flera vyer: multiview_image_urls kräver ai_model: "meshy-7" (eller latest).
Modell ej tillgänglig: ai_model: "meshy-7" rullas ut successivt och är ännu inte aktiverad för ditt konto.
Ogiltig indatauppgift: input_task_id måste hänvisa till en lyckad uppgift från en stödd modell.
Ogiltigt modelformat: model_url pekar på en fil med en ej stödd ändelse.
Otillgänglig URL: model_url, image_style_url eller ett multiview_image_urls-element kunde inte laddas ned.
Name
401 - Unauthorized
Description
Autentisering misslyckades. Kontrollera din API-nyckel.
Name
402 - Payment Required
Description
Otillräckliga 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
# Omtexturera med textpromptcurlhttps://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 }'# Omtexturera med bildstil och 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": "https://cdn.meshy.ai/image/example_image.jpg", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Detta endpoint tillåter dig att hämta en Omtextureringsuppgift givet ett giltigt id.
Se Omtextureringsuppgiftsobjektet för att se vilka egenskaper som ingår i Omtextureringsuppgiftsobjektet.
Parametrar
Name
id
Type
path
Description
Unik identifierare för Omtextureringsuppgiften att hämta.
{"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","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" } ],"task_error": {"message":"" },"consumed_credits":10}
[ {"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","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":10 }]
Omtextureringsuppfgiftsobjektet är en arbetsenhet som Meshy använder för att generera en 3D-textur från antingen text- eller bildingångar. Modellen har följande egenskaper:
Egenskaper
Name
id
Type
string
Description
Unik identifierare för uppgiften. Även om vi använder en k-sorterbar UUID för uppgifts-id som implementeringsdetalj, bör du inte göra några antaganden om formatet för id:t.
Name
type
Type
string
Description
Typ av Omtextureringsuppgift. Värdet är retexture.
Name
model_urls
Type
object
Description
Nedladdningsbar URL till den texturerade 3D-modellfilen som genereras 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, returnerad 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. Endast närvarande när 3mf var begärd 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 bildinmatningen som användes för att skapa textureringsuppgiften.
Name
multiview_image_urls
Type
string[]
Description
Nedladdningsbara URLer till de flera vy-referensbilder som användes för att skapa textureringsuppgiften. Endast närvarande 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 transparent-bakgrund (RGBA) version av thumbnail_url. Endast närvarande 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
Progress av uppgiften. Om uppgiften inte har startats ännu kommer denna egenskap att vara 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 startats ännu kommer denna egenskap att vara 0.
En tidsstämpel representerar antalet millisekunder som förflutit sedan den 1 januari 1970 UTC, enligt
RFC 3339-standarden.
Till exempel, fredag, 1 september 2023 kl. 12:00:00 GMT representeras 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 uppgiftsresultatet löper ut, i millisekunder.
Name
finished_at
Type
timestamp
Description
Tidsstämpel för när uppgiften slutfördes, i millisekunder. Om uppgiften inte har slutförts ännu kommer denna egenskap att vara 0.
Name
status
Type
string
Description
Status för uppgiften. Möjliga värden är PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
En lista över textur URL-objekt som genereras från uppgiften. Normalt innehåller detta endast en textur URL-objekt. Varje textur URL har följande egenskaper:
Name
base_color
Type
string
Description
Nedladdningsbar URL till grundfärg kartbilden.
Name
metallic
Type
string
Description
Nedladdningsbar URL till metallic kartbilden.
Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att utelämnas.
Name
normal
Type
string
Description
Nedladdningsbar URL till normalmap bild.
Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att utelämnas.
Name
roughness
Type
string
Description
Nedladdningsbar URL till rugghets kartbilden.
Om uppgiften skapas med enable_pbr: false, kommer denna egenskap att utelämnas.
Name
emission
Type
string
Description
Nedladdningsbar URL till emissions kartbild.
Om uppgiften skapas med enable_pbr: false, eller ai_model är meshy-5, kommer denna egenskap att utelämnas.
Name
preceding_tasks
Type
integer
Description
Antalet föregående uppgifter.
Denna egenskap är endast närvarande när uppgiftens status är PENDING.
Name
task_error
Type
object
Description
Felinformation för misslyckade uppgifter. Se Fel för hela task_error objekt referensen.
Name
consumed_credits
Type
integer
Description
Antalet credits som förbrukats av denna uppgift. Närvarande 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","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":10}