Retexture API est une fonctionnalité qui vous permet d'intégrer les capacités de Retexturisation par IA de Meshy dans votre propre application. Dans cette section, vous trouverez toutes les informations
dont vous avez besoin pour commencer à utiliser cette API.
Ce point de terminaison vous permet de créer une nouvelle tâche de Retexturisation. Consultez
L'objet tâche de Retexturisation pour voir quelles
propriétés sont incluses dans l'objet tâche de Retexturisation.
Paramètres
Seul un des deux paramètres input_task_id ou model_url est requis. Si les deux sont fournis, input_task_id est prioritaire.
Name
input_task_id
Type
string
Requis
Description
L'ID de la tâche Image en 3D ou Texte en 3D terminée que vous souhaitez retexturer.
Cette tâche doit être l'une des suivantes : Texte en 3D Preview, Texte en 3D Refine, Image en 3D ou Remaillage. De plus, elle doit avoir un statut SUCCEEDED.
Name
model_url
Type
string
Requis
Description
Fournissez un modèle 3D pour que Meshy le texture. Formats pris en charge : .glb, .gltf, .obj, .fbx, .stl.
Il existe deux façons de fournir le modèle :
URL accessible publiquement : une URL accessible depuis l'internet public.
Data URI : un Data URI encodé en base64 du modèle. Utilisez le MIME type application/octet-stream. Exemple : data:application/octet-stream;base64,<vos données de modèle encodées en base64>.
Exactement une entrée de style est requise : text_style_prompt, image_style_url, ou multiview_image_urls. multiview_image_urls ne peut pas être combiné avec l'un des deux autres ; si text_style_prompt et image_style_url sont tous deux fournis, image_style_url est prioritaire.
Name
text_style_prompt
Type
string
Requis
Description
Décrivez le style de texture souhaité pour l'objet à l'aide de texte. Maximum 800 caractères.
Name
image_style_url
Type
string
Requis
Description
Fournissez une image 2D pour guider le processus de texturation. Nous prenons actuellement en charge les formats .jpg, .jpeg, et .png.
Il existe deux façons de fournir l'image :
URL accessible publiquement : une URL accessible depuis l'internet public
Data URI : un Data URI encodé en base64 de l'image. Exemple de Data URI : data:image/jpeg;base64,<vos données d'image encodées en base64>
La texturation par image peut ne pas fonctionner de manière optimale s'il existe des différences de géométrie importantes entre l'asset original et l'image téléchargée.
Name
multiview_image_urls
Type
string[]
Requis
Description
Fournissez de 1 à 4 images montrant le même objet sous différents angles pour guider la texturation. La première image est la vue principale (de face) ; l'ordre des vues restantes (gauche, arrière, droite) n'a pas d'importance.
Chaque élément accepte les mêmes formats que image_style_url (une URL accessible publiquement ou un Data URI en base64, .jpg/.jpeg/.png).
Nécessite explicitement ai_model: "meshy-7".
Name
ai_model
Type
string
défaut latest
Description
ID du modèle d'IA à utiliser pour la retexturisation. Valeurs disponibles : meshy-6-lite, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
défaut false
Description
Conserve la disposition UV existante du modèle au lieu d'en générer une nouvelle.
Si vous retexturez un modèle généré par Meshy (via input_task_id, ou un model_url pointant vers une sortie Meshy), définissez ce paramètre sur true pour réutiliser sa disposition UV optimisée.
Si vous retexturez un modèle tiers que vous avez téléchargé, définissez true s'il possède déjà de bonnes UV que vous souhaitez conserver, ou laissez false pour laisser Meshy déplier de nouvelles UV (idéal pour les modèles sans mappage UV correct).
Name
enable_pbr
Type
boolean
défaut false
Description
Génère des cartes PBR (métallique, rugosité, normale) en plus de la couleur de base. Une carte d'émission est également incluse lorsque ai_model est meshy-6, sauf à texture_resolution: 8k. meshy-6-lite, meshy-7 et latest ne produisent pas de carte d'émission.
Name
texture_resolution
Type
string
défaut 2k
Description
Résolution de la texture de couleur de base. Une valeur parmi 2k (2048×2048), 4k (4096×4096), ou 8k (8192×8192). Des résolutions plus élevées capturent davantage de détails de surface.
4k et 8k nécessitent ai_modelmeshy-6, meshy-7 ou latest. À 8k, aucune carte d'émission n'est produite.
Name
hd_texture
Type
boolean
⚠ obsolète
défaut false
Description
Utilisez texture_resolution à la place — équivalent à texture_resolution: "4k". Lorsque les deux sont définis, texture_resolution est prioritaire.
Name
remove_lighting
Type
boolean
défaut true
Description
Supprime les reflets et les ombres de la texture de couleur de base, produisant un résultat plus propre qui fonctionne mieux avec des configurations d'éclairage personnalisées.
Uniquement pris en charge lorsque ai_model est meshy-6.
Name
target_formats
Type
string[]
Description
Spécifie les formats de fichiers 3D à inclure dans le résultat. Seuls les formats demandés seront générés et retournés, ce qui peut réduire le temps d'achèvement de la tâche. Si omis, tous les formats pris en charge sont inclus.
Si omis, tous les formats sauf 3mf sont générés. 3mf n'est inclus que lorsqu'il est explicitement spécifié.
Name
alpha_thumbnail
Type
boolean
défaut false
Description
Lorsque défini sur true, la tâche génère en plus une version à fond transparent (RGBA) de l'aperçu et la retourne sous forme de alpha_thumbnail_url dans la réponse GET. Le champ thumbnail_url existant reste inchangé.
Retours
La propriété result de la réponse contient l'id de tâche de la tâche de Retexturisation nouvellement créée.
Modes d'échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant : model_url ou input_task_id doit être fourni.
Style manquant : l'un des paramètres text_style_prompt, image_style_url ou multiview_image_urls doit être fourni.
Entrées de style en conflit : multiview_image_urls ne peut pas être combiné avec text_style_prompt ou image_style_url.
Modèle non pris en charge pour la vue multiple : multiview_image_urls nécessite explicitement ai_model: "meshy-7".
Modèle non disponible : ai_model: "meshy-7" et ai_model: "meshy-6-lite" sont déployés progressivement et peuvent ne pas encore être activés pour votre compte.
Tâche d'entrée invalide : input_task_id doit faire référence à une tâche réussie provenant d'un modèle pris en charge.
Format de modèle invalide : model_url pointe vers un fichier avec une extension non prise en charge.
URL inaccessible : model_url, image_style_url ou un élément de multiview_image_urls n'a pas pu être téléchargé.
Name
401 - Unauthorized
Description
L'authentification a échoué. Veuillez vérifier votre clé API.
Name
402 - Payment Required
Description
Crédits insuffisants pour effectuer cette tâche.
Name
429 - Too Many Requests
Description
Vous avez dépassé votre limite de débit.
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": "https://cdn.meshy.ai/image/example_image.jpg", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Ce point de terminaison vous permet de récupérer une tâche de Retexturisation à partir d'un id de tâche valide.
Consultez L'objet Tâche de retexturisation pour voir quelles
propriétés sont incluses dans l'objet de tâche de Retexturisation.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche de Retexturisation à récupérer.
Retours
La réponse contient l'objet de tâche de Retexturisation. Consultez la section
L'objet Tâche de retexturisation pour plus de détails.
{"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}
Ce point de terminaison supprime définitivement une tâche de retexturisation, y compris tous les modèles et données associés. Cette action est irréversible.
Paramètres de chemin
Name
id
Type
path
Description
L'ID de la tâche de retexturisation à supprimer.
Statut de la tâche
Une tâche qui est encore PENDING est supprimée et les crédits consommés
au moment de la création sont remboursés.
Une tâche déjà IN_PROGRESS ne peut pas être supprimée : la requête est
rejetée avec 409 Conflict et la tâche continue de s'exécuter. Les crédits
d'une tâche déjà démarrée par le worker ne sont pas remboursables, donc la
supprimer en cours d'exécution vous ferait perdre à la fois les crédits et
le résultat. Attendez qu'elle atteigne SUCCEEDED, FAILED ou CANCELED,
puis supprimez-la.
Une tâche dans un état terminal (SUCCEEDED, FAILED ou CANCELED) est
supprimée sans remboursement.
Retours
Retourne 200 OK en cas de succès, ou 409 Conflict lorsque la tâche est
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","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 }]
L'objet Retexture Task est une unité de travail que Meshy utilise pour générer une texture 3D à partir d'entrées textuelles ou d'images.
Le modèle possède les propriétés suivantes :
Propriétés
Name
id
Type
string
Description
Identifiant unique de la tâche. Bien que nous utilisions un UUID k-sortable pour les identifiants de tâche comme
détail d'implémentation, vous ne devez pas faire d'hypothèses sur le format de l'id.
Name
type
Type
string
Description
Type de la tâche de Retexturisation. La valeur est retexture.
Name
model_urls
Type
object
Description
URL téléchargeable vers le fichier de modèle 3D texturé généré par Meshy.
Name
glb
Type
string
Description
URL téléchargeable vers le fichier GLB.
Name
fbx
Type
string
Description
URL téléchargeable vers le fichier FBX.
Name
obj
Type
string
Description
URL téléchargeable vers le fichier OBJ.
Name
usdz
Type
string
Description
URL téléchargeable vers le fichier USDZ.
Name
mtl
Type
string
Description
URL téléchargeable vers le fichier MTL, renvoyé aux côtés des exports OBJ lorsque des textures sont présentes.
Name
stl
Type
string
Description
URL téléchargeable vers le fichier STL.
Name
3mf
Type
string
Description
URL téléchargeable vers le fichier 3MF. Présent uniquement lorsque 3mf a été demandé via target_formats.
Name
text_style_prompt
Type
string
Description
Il s'agit du prompt textuel qui a été utilisé pour créer la tâche de texturisation.
Name
image_style_url
Type
string
Description
Il s'agit de l'image d'entrée qui a été utilisée pour créer la tâche de texturisation.
Name
multiview_image_urls
Type
string[]
Description
URLs téléchargeables vers les images de référence Multi-vue qui ont été utilisées pour créer la tâche de texturisation. Présent uniquement lorsque la tâche a été créée avec multiview_image_urls.
Name
thumbnail_url
Type
string
Description
URL téléchargeable vers l'image miniature du fichier de modèle.
Name
alpha_thumbnail_url
Type
string
Description
URL téléchargeable vers une version à fond transparent (RGBA) de thumbnail_url. Présent uniquement lorsque la tâche a été créée avec alpha_thumbnail: true et que l'aperçu transparent a été rendu avec succès ; sinon, ce champ est omis.
Name
progress
Type
integer
Description
Progression de la tâche. Si la tâche n'a pas encore démarré, cette propriété vaudra 0. Une fois la tâche réussie, elle deviendra 100.
Name
started_at
Type
timestamp
Description
Horodatage du démarrage de la tâche, en millisecondes. Si la tâche n'a pas encore démarré, cette propriété vaudra 0.
Un horodatage représente le nombre de millisecondes écoulées depuis le 1er janvier 1970 UTC, selon
la norme RFC 3339.
Par exemple, le vendredi 1er septembre 2023 à 12h00m00s GMT est représenté par 1693569600000. Cela s'applique
à tous les horodatages de Meshy API.
Name
created_at
Type
timestamp
Description
Horodatage de la création de la tâche, en millisecondes.
Name
expires_at
Type
timestamp
Description
Horodatage de l'expiration du résultat de la tâche, en millisecondes.
Name
finished_at
Type
timestamp
Description
Horodatage de la fin de la tâche, en millisecondes. Si la tâche n'est pas encore terminée, cette propriété vaudra 0.
Name
status
Type
string
Description
Statut de la tâche. Les valeurs possibles sont PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un tableau d'objets d'URL de texture générés par la tâche. Normalement, il ne contient qu'un seul objet d'URL de texture. Chaque URL de texture possède les propriétés suivantes :
Name
base_color
Type
string
Description
URL téléchargeable vers l'image de la carte de couleur de base.
Name
metallic
Type
string
Description
URL téléchargeable vers l'image de la carte métallique.
Si la tâche est créée avec enable_pbr: false, cette propriété sera omise.
Name
normal
Type
string
Description
URL téléchargeable vers l'image de la normal map.
Si la tâche est créée avec enable_pbr: false, cette propriété sera omise.
Name
roughness
Type
string
Description
URL téléchargeable vers l'image de la carte de rugosité.
Si la tâche est créée avec enable_pbr: false, cette propriété sera omise.
Name
emission
Type
string
Description
URL téléchargeable vers l'image de la carte d'émission.
Si la tâche est créée avec enable_pbr: false, ou si ai_model est meshy-6-lite, cette propriété sera omise.
Name
preceding_tasks
Type
integer
Description
Le nombre de tâches précédentes.
Cette propriété n'est présente que lorsque le statut de la tâche est PENDING.
Name
task_error
Type
object
Description
Détails de l'erreur pour les tâches échouées. Consultez Erreurs pour la référence complète de l'objet task_error.
Name
consumed_credits
Type
integer
Description
Le nombre de crédits consommés par cette tâche. Présent lorsque le statut de la tâche est PENDING, IN_PROGRESS, ou SUCCEEDED. Retourne 0 pour les tâches FAILED (les crédits sont remboursés en cas d'échec).
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}