lowpoly wordt op 30 okt 2026 uitgefaseerd. Stap vóór deze datums over op een ander model om fouten bij verzoeken te voorkomen.
Retexture API
Retexture API is een functie waarmee je Meshy's AI-hertexturingsmogelijkheden in je eigen applicatie kunt integreren. In dit gedeelte vind je alle informatie
die je nodig hebt om met deze API aan de slag te gaan.
Deze endpoint stelt je in staat om een nieuwe Retexture-taak aan te maken. Raadpleeg
Het Retexture Task Object om te zien welke
eigenschappen deel uitmaken van het Retexture-taakobject.
De taak wordt op de achtergrond uitgevoerd. Voor een indicatie van de verwerkingstijd, zie Verwerkingstijden.
Parameters
Slechts één van input_task_id of model_url is verplicht. Als beide worden opgegeven, krijgt input_task_id voorrang.
Name
input_task_id
Type
string
Verplicht
Description
De ID van de voltooide Afbeelding naar 3D- of Tekst naar 3D-taak die je opnieuw van textuur wilt voorzien.
Deze taak moet een van de volgende taken zijn: Text to 3D Preview, Text to 3D Refine, Image to 3D of Remesh. Daarnaast moet de status SUCCEEDED zijn.
Name
model_url
Type
string
Verplicht
Description
Geef een 3D-model op dat Meshy moet textureren. Ondersteunde formaten: .glb, .gltf, .obj, .fbx, .stl.
Maximale bestandsgrootte: 400 MB voor een http- of https-URL, 100 MB voor een data:-URI.
Een GLB-, glTF-, FBX- of OBJ-bestand groter dan 100 MB mag maximaal 10.000.000 faces bevatten. Faces worden geteld als driehoeken: een vierhoek telt als 2, en een mesh die meerdere keren getekend wordt telt per kopie één keer. Boven 100 MB moet een FBX-bestand binaire FBX 7.1 of nieuwer zijn, en mag een GLB- of glTF-bestand geen Draco-compressie gebruiken.
Er zijn twee manieren om het model aan te leveren:
Publiek toegankelijke URL: Een URL die toegankelijk is vanaf het openbare internet.
Data URI: Een base64-gecodeerde data-URI van het model. Gebruik MIME type application/octet-stream. Voorbeeld: data:application/octet-stream;base64,<je base64-gecodeerde modelgegevens>.
Precies één stijlinvoer is verplicht: text_style_prompt, image_style_url, of multiview_image_urls. multiview_image_urls kan niet worden gecombineerd met een van de andere twee; als zowel text_style_prompt als image_style_url worden opgegeven, krijgt image_style_url voorrang.
Name
text_style_prompt
Type
string
Verplicht
Description
Beschrijf de gewenste textuurstijl van het object met tekst. Maximaal 800 tekens.
Name
image_style_url
Type
string
Verplicht
Description
Geef een 2D-afbeelding op om het textureerproces te sturen. We ondersteunen momenteel de formaten .jpg, .jpeg, .png en .webp.
Maximale bestandsgrootte: 20 MB.
Er zijn twee manieren om de afbeelding aan te leveren:
Publiek 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,<je base64-gecodeerde afbeeldingsgegevens>
Het textureren met een afbeelding werkt mogelijk niet optimaal als er aanzienlijke geometrische verschillen zijn tussen het oorspronkelijke asset en de geüploade afbeelding.
Name
multiview_image_urls
Type
string[]
Verplicht
Description
Geef 1 tot 4 afbeeldingen op die hetzelfde object vanuit verschillende hoeken tonen om het textureren te sturen. De eerste afbeelding is het primaire (voor)aanzicht; de volgorde van de overige aanzichten (links, achter, rechts) maakt niet uit.
Elk element accepteert dezelfde formaten als image_style_url (een publiek toegankelijke URL of een base64 data-URI, .jpg/.jpeg/.png/.webp).
Maximale bestandsgrootte: 20 MB per afbeelding.
Vereist een expliciete ai_model: "meshy-7".
Name
ai_model
Type
string
standaard latest
Description
ID van het AI-model dat gebruikt wordt voor het hertextureren. Beschikbare waarden: meshy-6-lite, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
standaard false
Description
Behoud de bestaande UV-layout van het model in plaats van een nieuwe te genereren.
Als je een model hertextureert dat door Meshy is gegenereerd (via input_task_id, of een model_url die naar een Meshy-uitvoer verwijst), zet dit dan op true om de geoptimaliseerde UV-layout opnieuw te gebruiken.
Als je een door jou geüpload model van een derde partij hertextureert, zet dit op true wanneer het al goede UV's heeft die je wilt behouden, of laat het op false staan zodat Meshy nieuwe UV's uitvouwt (het beste voor modellen zonder goede UV-mapping).
Name
enable_pbr
Type
boolean
standaard false
Description
Genereer PBR-maps (metallic, roughness, normal) naast de basiskleur. Er wordt ook een emission map meegeleverd wanneer ai_modelmeshy-6 is, behalve bij texture_resolution: 8k. meshy-6-lite, meshy-7 en latest produceren geen emission map.
Name
texture_resolution
Type
string
standaard 2k
Description
Resolutie van de basiskleurtextuur. Een van 2k (2048×2048), 4k (4096×4096), of 8k (8192×8192). Hogere resoluties leggen meer oppervlaktedetails vast.
4k en 8k vereisen ai_modelmeshy-6, meshy-7 of latest. Bij 8k wordt geen emission map geproduceerd.
Name
hd_texture
Type
boolean
⚠ verouderd
standaard false
Description
Gebruik in plaats daarvan texture_resolution — gelijk aan texture_resolution: "4k". Wanneer beide zijn ingesteld, heeft texture_resolution voorrang.
Name
remove_lighting
Type
boolean
standaard true
Description
Verwijdert lichtvlekken en schaduwen uit de basiskleurtextuur, wat een schoner resultaat oplevert dat beter werkt bij aangepaste belichtingsopstellingen.
Wordt alleen toegepast wanneer ai_modelmeshy-6 is en texture_resolution2k of 4k is. Bij meshy-7 of latest, en bij 8k, wordt deze geaccepteerd maar genegeerd. Bij meshy-6-lite geeft het meesturen van deze parameter met welke waarde dan ook een 400 terug.
Name
target_formats
Type
string[]
Description
Specificeert welke 3D-bestandsformaten in de uitvoer moeten worden opgenomen. Alleen de gevraagde formaten worden gegenereerd en geretourneerd, wat de taakverwerkingstijd kan verkorten. Indien weggelaten, worden alle ondersteunde formaten opgenomen.
Indien weggelaten, worden alle formaten behalve 3mf gegenereerd. 3mf wordt alleen opgenomen wanneer dit expliciet wordt opgegeven.
Name
alpha_thumbnail
Type
boolean
standaard false
Description
Wanneer ingesteld op true, rendert de taak extra een versie van de preview met een transparante achtergrond (RGBA) en retourneert deze als alpha_thumbnail_url in het GET-antwoord. Het bestaande veld thumbnail_url blijft ongewijzigd.
Retourwaarden
De eigenschap result van het antwoord bevat de taak-id van de nieuw aangemaakte Retexture-taak.
Faalmodi
Name
400 - Bad Request
Description
Het verzoek was onacceptabel. Veelvoorkomende oorzaken:
Ontbrekende parameter: Ofwel model_url ofwel input_task_id moet worden opgegeven.
Ontbrekende stijl: Een van text_style_prompt, image_style_url of multiview_image_urls moet worden opgegeven.
Conflicterende stijlinvoer: multiview_image_urls kan niet worden gecombineerd met text_style_prompt of image_style_url.
Niet-ondersteund model voor meerdere aanzichten: multiview_image_urls vereist een expliciete ai_model: "meshy-7".
Model niet beschikbaar: ai_model: "meshy-7" en ai_model: "meshy-6-lite" worden geleidelijk uitgerold en zijn mogelijk nog niet ingeschakeld voor jouw account.
Ongeldige invoertaak: De input_task_id moet verwijzen naar een succesvolle taak van een ondersteund model.
Ongeldig modelformaat: De model_url verwijst naar een bestand met een niet-ondersteunde extensie.
Onbereikbare URL: De model_url, image_style_url of een element van multiview_image_urls kon niet worden gedownload.
Modelbestand te groot: Het bestand van model_url overschrijdt 400 MB (http- of https-URL) of 100 MB (data:-URI).
Te veel faces: Het bestand van model_url is groter dan 100 MB en heeft meer dan 10.000.000 faces. Verminder het aantal faces en stuur het bestand opnieuw.
ASCII FBX boven 100 MB: Het bestand van model_url is een ASCII FBX groter dan 100 MB. Stuur het als binaire FBX of GLB.
Onleesbaar modelbestand: Het bestand van model_url is groter dan 100 MB en de header kan niet worden gelezen, bijvoorbeeld een met Draco gecomprimeerde GLB of glTF, of een binaire FBX ouder dan 7.1.
Modelheader te complex: Het bestand van model_url is groter dan 100 MB en de header heeft te veel meshes, nodes of records om te controleren. Verminder het aantal objecten in het bestand en stuur het opnieuw.
Afbeelding te groot: De afbeelding van image_style_url of een element van multiview_image_urls overschrijdt 20 MB.
Name
401 - Unauthorized
Description
Authenticatie mislukt. Controleer je API-sleutel.
Name
402 - Payment Required
Description
Onvoldoende credits om deze taak uit te voeren.
Name
429 - Too Many Requests
Description
Je hebt je rate limit overschreden.
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 }'
Deze endpoint stelt u in staat om een Retexture-taak op te halen aan de hand van een geldige taak-id.
Raadpleeg Het Retexture-taakobject om te zien welke
eigenschappen zijn opgenomen in het Retexture-taakobject.
Parameters
Name
id
Type
path
Description
Unieke identificatie van de op te halen Retexture-taak.
Retourwaarden
De respons bevat het Retexture-taakobject. Raadpleeg de sectie
Het Retexture-taakobject voor details.
{"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}
Deze endpoint verwijdert permanent een Hertextureren-taak, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.
Padparameters
Name
id
Type
path
Description
De ID van de Hertextureren-taak die moet worden verwijderd.
Taakstatus
Een taak die nog PENDING is, wordt verwijderd en de credits die bij het
aanmaken zijn verbruikt, worden terugbetaald.
Een taak die al IN_PROGRESS is, kan niet worden verwijderd: het verzoek
wordt afgewezen met 409 Conflict en de taak blijft doorlopen. Credits voor
een taak die de worker al is gestart, worden niet terugbetaald, dus het
verwijderen ervan tijdens uitvoering zou je zowel de credits als het
resultaat kosten. Wacht tot de taak SUCCEEDED, FAILED of CANCELED
bereikt, en verwijder deze dan.
Een taak in een eindstatus (SUCCEEDED, FAILED of CANCELED) wordt
verwijderd zonder terugbetaling.
Resultaten
Retourneert 200 OK bij succes, of 409 Conflict wanneer de taak
IN_PROGRESS is.
// 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 }]
Het Retexture Task object is een werkeenheid die Meshy gebruikt om een 3D-textuur te genereren op basis van tekst- of afbeeldinginvoer.
Het model heeft de volgende eigenschappen:
Eigenschappen
Name
id
Type
string
Description
Unieke identifier voor de taak. Hoewel we als implementatiedetail een k-sortable UUID gebruiken voor task-id's,
mag je geen aannames doen over de indeling van de id.
Name
type
Type
string
Description
Type van de Retexture-taak. De waarde is retexture.
Name
model_urls
Type
object
Description
Downloadbare URL naar het getextureerde 3D-modelbestand dat door Meshy is gegenereerd.
Name
glb
Type
string
Description
Downloadbare URL naar het GLB-bestand.
Name
fbx
Type
string
Description
Downloadbare URL naar het FBX-bestand.
Name
obj
Type
string
Description
Downloadbare URL naar het OBJ-bestand.
Name
usdz
Type
string
Description
Downloadbare URL naar het USDZ-bestand.
Name
mtl
Type
string
Description
Downloadbare URL naar het MTL-bestand, meegeleverd bij OBJ-exports wanneer er texturen aanwezig zijn.
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
text_style_prompt
Type
string
Description
Dit is de tekst-prompt die is gebruikt om de textureertaak te maken.
Name
image_style_url
Type
string
Description
Dit is de afbeeldingsinvoer die is gebruikt om de textureertaak te maken.
Name
multiview_image_urls
Type
string[]
Description
Downloadbare URL's naar de Meerdere aanzichten-referentieafbeeldingen die zijn gebruikt om de textureertaak te maken. Alleen aanwezig wanneer de taak is aangemaakt met multiview_image_urls.
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 van thumbnail_url met transparante achtergrond (RGBA). Alleen aanwezig wanneer de taak is aangemaakt met alpha_thumbnail: true en de transparante preview succesvol is gerenderd; anders wordt dit veld weggelaten.
Name
progress
Type
integer
Description
Voortgang 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.
Vrijdag 1 september 2023 12:00:00 PM GMT wordt bijvoorbeeld weergegeven als 1693569600000. Dit geldt
voor alle tijdstempels in de Meshy API.
Name
created_at
Type
timestamp
Description
Tijdstempel van wanneer de taak is aangemaakt, in milliseconden.
Name
expires_at
Type
timestamp
Description
Tijdstempel van wanneer het taakresultaat verloopt, 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 door de taak zijn 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, met ai_modelmeshy-6-lite, meshy-7 of latest, of met texture_resolution: 8k, wordt deze eigenschap weggelaten.
Name
preceding_tasks
Type
integer
Description
Het aantal voorafgaande taken.
Deze eigenschap is alleen aanwezig wanneer de taakstatus PENDING is.
Name
task_error
Type
object
Description
Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.
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. Geeft 0 terug voor FAILED-taken (credits worden terugbetaald bij een mislukking).
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}