L’API Texte en 3D est une fonctionnalité qui vous permet d’intégrer les capacités Texte en 3D de Meshy à votre propre application. Dans cette section, vous trouverez toutes les informations
dont vous avez besoin pour démarrer avec cette API.
Texte en 3D utilise un flux de travail en deux étapes. Commencez par créer une tâche de prévisualisation (mode: "preview") pour générer un maillage 3D sans texture, afin de pouvoir évaluer la forme. Ensuite, transmettez l’ID de tâche de la prévisualisation terminée à une tâche d’affinage (mode: "refine") pour appliquer une texture au maillage. Les deux étapes partagent le même point de terminaison.
Ce point de terminaison crée une tâche d’aperçu Texte en 3D, qui génère un maillage 3D sans texture (géométrie uniquement) à partir d’un prompt texte. Il s’agit de la première étape du flux de travail en deux étapes. Une fois l’aperçu réussi, utilisez l’ID de tâche renvoyé pour créer une tâche d’affinage afin d’appliquer les textures. Consultez
L’objet de tâche Texte en 3D pour le schéma de réponse complet.
Paramètres
Name
mode
Type
string
Requis
Description
Ce champ doit être défini sur "preview" lors de la création d’une tâche d’aperçu.
Name
prompt
Type
string
Requis
Description
Décrivez le type d’objet que représente le modèle 3D. Maximum 600 caractères.
Name
model_type
Type
string
défaut standard
Description
Spécifiez le type de génération de maillage 3D.
Valeurs disponibles :
standard: Génération de maillage 3D standard à haut niveau de détail.
lowpoly: Génère un maillage low-poly optimisé pour des polygones plus propres.
Lorsque lowpoly est sélectionné, ai_model, topology, target_polycount, should_remesh sont ignorés.
Name
ai_model
Type
string
défaut latest
Description
ID du modèle à utiliser. Valeurs disponibles : meshy-5, meshy-6, latest (Meshy 6).
Name
should_remesh
Type
boolean
défaut false (meshy-6), true (others)
Description
Contrôle l’activation ou non de la phase de Remaillage. Lorsque défini sur false, l’API renverra directement le maillage triangulaire de la plus haute précision.
S'applique uniquement quand should_remesh = true
Name
topology
Type
string
défaut triangle
Description
Spécifiez la topology du modèle généré.
Valeurs disponibles :
quad: Génère un maillage à dominante quadrilatérale.
triangle: Génère un maillage triangulaire décimé.
Name
target_polycount
Type
integer
défaut 30,000
Description
Spécifiez le nombre cible de polygones dans le modèle généré. Le nombre réel de polygones peut s’écarter de la cible selon la complexité de la géométrie.
La plage de valeurs valide varie selon le niveau utilisateur :
100 à 300 000 (inclus)
Name
decimation_mode
Type
integer
Description
Activez la décimation adaptative en définissant un niveau de nombre de polygones. Lorsque ce paramètre est défini, target_polycount est ignoré.
Valeurs disponibles :
1: Adaptatif — nombre de polygones ultra-élevé.
2: Adaptatif — nombre de polygones élevé.
3: Adaptatif — nombre de polygones moyen.
4: Adaptatif — nombre de polygones faible.
Name
symmetry_mode
Type
string
⚠ obsolète
défaut auto
Description
Obsolète (deprecated). Ce paramètre n’affecte plus la sortie.
Le champ symmetry_mode contrôle le comportement de symétrie pendant le processus de génération du modèle.
Les valeurs valides sont :
off: Désactive la symétrie.
auto: Détermine et applique automatiquement la symétrie en fonction de la géométrie d’entrée.
Utilisez pose_mode à la place. Indique s’il faut générer le modèle en pose A/T.
Name
art_style
Type
string
⚠ obsolète
défaut realistic
Description
Non pris en charge par Meshy-6. Les requêtes utilisant Meshy-6 ignoreront art_style, et certaines combinaisons peuvent provoquer des erreurs. Valeurs disponibles : realistic, sculpture.
enable_pbr doit être défini sur false lors de l’utilisation du style Sculpture, car le style Sculpture génère son propre ensemble de cartes PBR.
Name
moderation
Type
boolean
défaut false
Description
Lorsque défini sur true, le contenu d’entrée sera automatiquement analysé pour détecter du contenu potentiellement nuisible. Si un contenu nuisible est détecté, la tâche ne passera pas à la génération.
Le texte de prompt sera analysé.
Name
target_formats
Type
string[]
Description
Spécifie les formats de fichiers 3D à inclure dans la sortie. Seuls les formats demandés seront générés et renvoyés, ce qui peut réduire le temps d’exécution de la tâche. En cas d’omission, tous les formats pris en charge sont inclus.
En cas d’omission, 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 rend en plus une version de l’aperçu avec arrière-plan transparent (RGBA) et la renvoie sous la forme alpha_thumbnail_url dans la réponse GET. Le champ existant thumbnail_url reste inchangé.
Name
auto_size
Type
boolean
défaut false
Description
Lorsque défini sur true, le service utilise la vision par IA pour estimer automatiquement la hauteur réelle de l’objet et redimensionner le modèle en conséquence. L’origine sera par défaut bottom, sauf si origin_at est explicitement défini.
S'applique uniquement quand auto_size = true
Name
origin_at
Type
string
défaut bottom
Description
Position de l’origine lorsque auto_size est activé.
Valeurs disponibles : bottom, center.
Retours
La propriété result de la réponse contient l’id de tâche de la tâche Texte en 3D nouvellement créée.
Modes d’échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant: Un paramètre requis (par ex., prompt, mode) est manquant.
Paramètre invalide: art_style ne fait pas partie des valeurs autorisées.
Prompt trop long: Le prompt dépasse la limite de caractères.
Name
401 - Unauthorized
Description
L’authentification a échoué. Veuillez vérifier votre clé API.
Ce point de terminaison crée une tâche d’affinage Texte en 3D, qui applique une texture à un maillage de prévisualisation terminé. Vous devez fournir le preview_task_id d’une tâche de prévisualisation réussie. Il s’agit de la deuxième étape du workflow en deux étapes.
Paramètres
Name
mode
Type
string
Requis
Description
Ce champ doit être défini sur "refine" lors de la création d’une tâche d’affinage.
Name
preview_task_id
Type
string
Requis
Description
L’ID de la tâche de prévisualisation correspondante.
Le statut de la tâche de prévisualisation fournie doit être SUCCEEDED.
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 ou latest.
Name
hd_texture
Type
boolean
défaut false
Description
Génère la texture de couleur de base en résolution 4K (4096×4096) pour un niveau de détail plus élevé.
Pris en charge uniquement lorsque ai_model est meshy-6 ou latest. Les cartes PBR sont toujours générées en 2K.
Name
texture_prompt
Type
string
Description
Fournissez un prompt textuel supplémentaire pour guider le processus de texturage. Maximum 600 caractères.
Name
texture_image_url
Type
string
Description
Fournissez une image 2D pour guider le processus de texturage. 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 : une Data URI encodée en base64 de l’image. Exemple de Data URI : data:image/jpeg;base64,<your base64-encoded image data>
Le texturage à partir d’une image peut ne pas fonctionner de manière optimale s’il existe des différences de géométrie importantes entre l’asset d’origine et l’image téléversée. Un seul des paramètres texture_image_url ou texture_prompt peut être utilisé pour guider le processus de texturage. Si les deux paramètres sont fournis, alors texture_prompt sera utilisé par défaut pour texturer le modèle.
Name
ai_model
Type
string
défaut latest
Description
ID du modèle à utiliser pour l’affinage. Valeurs disponibles : meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
défaut false
Description
Lorsque ce paramètre est défini sur true, le contenu d’entrée sera automatiquement analysé afin de détecter du contenu potentiellement nuisible. Si du contenu nuisible est détecté, la tâche ne passera pas à la génération.
Le texte de texture_prompt et l’image de texture_image_url seront tous deux analysés.
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.
Pris en charge uniquement lorsque ai_model est meshy-6 ou latest.
Name
target_formats
Type
string[]
Description
Spécifie les formats de fichiers 3D à inclure dans la sortie. Seuls les formats demandés seront générés et renvoyés, ce qui peut réduire le temps de réalisation de la tâche. En cas d’omission, tous les formats pris en charge sont inclus.
En cas d’omission, tous les formats sauf 3mf sont générés. 3mf est inclus uniquement lorsqu’il est explicitement spécifié.
Name
alpha_thumbnail
Type
boolean
défaut false
Description
Lorsque ce paramètre est défini sur true, la tâche rend en plus une version de la prévisualisation avec arrière-plan transparent (RGBA) et la renvoie sous la forme alpha_thumbnail_url dans la réponse GET. Le champ existant thumbnail_url reste inchangé.
Name
auto_size
Type
boolean
défaut false
Description
Lorsque ce paramètre est défini sur true, le service utilise la vision par IA pour estimer automatiquement la hauteur réelle de l’objet et redimensionner le modèle en conséquence. L’origine sera par défaut bottom, sauf si origin_at est explicitement défini.
S'applique uniquement quand auto_size = true
Name
origin_at
Type
string
défaut bottom
Description
Position de l’origine lorsque auto_size est activé.
Valeurs disponibles : bottom, center.
Retours
La propriété result de la réponse contient l’id de tâche de la nouvelle tâche Texte en 3D créée.
Modes d’échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes fréquentes :
ID de tâche invalide : le preview_task_id est invalide ou n’existe pas.
Tâche non prête : la tâche de prévisualisation n’a pas encore réussi.
Incompatibilité de modèle : le modèle d’IA de la tâche de prévisualisation est incompatible avec le modèle d’affinage demandé.
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
404 - Not Found
Description
La tâche de prévisualisation spécifiée par preview_task_id est introuvable.
Ce point de terminaison vous permet de récupérer une tâche Texte en 3D à partir d’un id de tâche valide.
Consultez L’objet de tâche Texte en 3D pour voir quelles
propriétés sont incluses avec l’objet de tâche Texte en 3D.
Ce point de terminaison fonctionne à la fois pour les tâches de prévisualisation et d’affinage.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche Texte en 3D à récupérer.
Retours
La réponse contient l’objet de tâche Texte en 3D. Consultez la section
L’objet de tâche Texte en 3D pour plus de détails.
L’objet de tâche Texte en 3D est une unité de travail que Meshy suit pour générer un modèle 3D à partir d’une entrée texte. L’API Texte en 3D comporte deux étapes, preview et refine. L’étape d’aperçu sert à générer un modèle 3D uniquement en maillage, et l’étape d’affinage sert à générer un modèle 3D avec texture basé sur le résultat de l’étape d’aperçu.
L’objet 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 triable en k 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 Texte en 3D. Les valeurs possibles sont text-to-3d-preview pour les tâches de l’étape de prévisualisation et text-to-3d-refine pour les tâches de l’étape d’affinage.
Name
model_urls
Type
object
Description
URL téléchargeable du fichier de modèle 3D texturé généré par Meshy. La propriété d’un format sera omise si le format n’est pas généré, au lieu de renvoyer une chaîne vide.
Name
glb
Type
string
Description
URL téléchargeable du fichier GLB.
Name
fbx
Type
string
Description
URL téléchargeable du fichier FBX.
Name
usdz
Type
string
Description
URL téléchargeable du fichier USDZ.
Name
obj
Type
string
Description
URL téléchargeable du fichier OBJ.
Name
mtl
Type
string
Description
URL téléchargeable du fichier MTL.
Name
stl
Type
string
Description
URL téléchargeable du fichier STL.
Name
3mf
Type
string
Description
URL téléchargeable du fichier 3MF. Présent uniquement lorsque 3mf a été demandé via target_formats.
Name
prompt
Type
string
Description
Il s’agit du prompt non modifié qui a été utilisé pour créer la tâche.
Name
negative_prompt
Type
string
⚠ obsolète
Description
Maintenu pour compatibilité descendante. Ce champ n’a aucun impact fonctionnel sur les modèles générés.
Name
art_style
Type
string
⚠ obsolète
Description
Le art_style non modifié qui a été utilisé pour créer la tâche de prévisualisation. Non pris en charge par Meshy-6.
Name
texture_richness
Type
string
⚠ obsolète
Description
Maintenu pour compatibilité descendante. Ce champ n’a aucun impact fonctionnel sur les modèles générés.
Name
texture_prompt
Type
string
Description
Prompt textuel supplémentaire fourni pour guider le processus d’application de texture pendant l’étape d’affinage.
Name
texture_image_url
Type
string
Description
URL téléchargeable de l’image de texture qui a été utilisée pour guider le processus d’application de texture.
Name
thumbnail_url
Type
string
Description
URL téléchargeable de l’image miniature du fichier de modèle.
Name
alpha_thumbnail_url
Type
string
Description
URL téléchargeable d’une version à arrière-plan transparent (RGBA) de thumbnail_url. Présent uniquement lorsque la tâche a été créée avec alpha_thumbnail: true et que la prévisualisation transparente a été rendue avec succès ; sinon, ce champ est omis.
Name
video_url
Type
string
⚠ obsolète
Description
URL téléchargeable de la vidéo de prévisualisation. Sera supprimée dans une prochaine version.
Name
progress
Type
integer
Description
progress de la tâche. Si la tâche n’a pas encore démarré, cette propriété sera 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é sera 0.
Un horodatage représente le nombre de millisecondes écoulées depuis le 1er janvier 1970 UTC, conformément
à la norme RFC 3339.
Par exemple, vendredi 1er septembre 2023 à 12:00:00 PM GMT est représenté par 1693569600000. Cela s’applique
à tous les horodatages dans Meshy API.
Name
created_at
Type
timestamp
Description
Horodatage de la création 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é sera 0.
Name
status
Type
string
Description
Statut de la tâche. Les valeurs possibles sont l’une de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un tableau d’objets d’URL de texture générés à partir de la tâche. Normalement, il ne contient qu’un 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 de l’image de map de couleur de base.
Name
metallic
Type
string
Description
URL téléchargeable de l’image de map 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 de l’image de 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 de l’image de map 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 de l’image de map d’émission.
Si la tâche est créée avec enable_pbr: false, ou si ai_model est meshy-5, cette propriété sera omise.
Name
preceding_tasks
Type
integer
Description
Le nombre de tâches précédentes.
La valeur de ce champ n’a de signification que si le statut de la tâche est PENDING.
Name
task_error
Type
object
Description
Détails de l’erreur pour les tâches ayant échoué. 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. Renvoie 0 pour les tâches FAILED (les crédits sont remboursés en cas d’échec).
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,"seed":1234,"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}