Multi-Image à 3D API est une fonctionnalité qui vous permet d'intégrer les capacités Multi-Image à 3D de Meshy dans votre propre application. Dans cette section, vous trouverez toutes les informations nécessaires pour commencer avec cette API.
Ce point de terminaison vous permet de créer une nouvelle tâche Multi-Image à 3D. Référez-vous à
L'objet de la tâche Multi-Image à 3D pour voir quelles
propriétés sont incluses avec l'objet tâche Multi-Image à 3D.
Paramètres
Seul un des input_task_id ou image_urls est requis. Si les deux sont fournis, input_task_id prend la priorité.
Name
input_task_id
Type
string
Requis
Description
L'ID d'une tâche d'image terminée dont la sortie (1 à 4 images) doit être utilisée comme entrée. Cette tâche doit être l'une des tâches suivantes: Texte en image, Image en image, Texte en image Multi-vue, ou Image en image Multi-vue. De plus, elle doit avoir été exécutée via l'API et avoir un statut de SUCCEEDED.
Name
image_urls
Type
array
Requis
Description
Fournissez de 1 à 4 images pour que Meshy les utilise dans la création de modèle. Nous supportons actuellement les formats .jpg, .jpeg, et .png. Toutes les images doivent représenter le même objet sous différents angles pour obtenir les meilleurs résultats.
Il existe deux façons de fournir chaque image :
URL accessible publiquement : Une URL accessible depuis Internet public.
Data URI : Un URI de données encodé en base64 de l'image. Exemple d'un Data URI: data:image/jpeg;base64,<vos données d'image encodées en base64>.
Pour meshy-7 (ou latest), la première image est utilisée comme vue principale (avant). L'ordre des autres images n'a pas d'importance.
Name
ai_model
Type
string
défaut latest
Description
ID du modèle à utiliser. Valeurs disponibles: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
should_texture
Type
boolean
défaut true
Description
Détermine si les textures sont générées. Le définir à false saute la phase de texture, fournissant un maillage sans texture.
S'applique uniquement quand should_texture = true
Name
enable_pbr
Type
boolean
défaut false
Description
Génère des cartes PBR (métallique, rugosité, normal) 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-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. L'un des 2k (2048×2048), 4k (4096×4096), ou 8k (8192×8192). Les résolutions plus élevées capturent plus 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 prend le pas.
Name
texture_prompt
Type
string
Description
Fournissez un prompt textuel pour guider le processus de texturation. Maximum 600 caractères.
Name
texture_image_url
Type
string
Description
Fournissez une image 2D pour guider le processus de texturation. Nous supportons actuellement les formats .jpg, .jpeg, et .png.
Il existe deux façons de fournir l'image :
URL accessible publiquement : Une URL accessible depuis Internet public
Data URI : Un URI de données encodé en base64 de l'image. Exemple d'un 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 y a des différences significatives de géométrie entre l'asset original et l'image téléchargée. Seul un des texture_image_url ou texture_prompt peut être utilisé pour guider le processus de texturation. Si les deux paramètres sont fournis, alors texture_prompt sera utilisé pour texturer le modèle par défaut.
Name
should_remesh
Type
boolean
défaut false (meshy-6), true (others)
Description
Contrôle si le remeshing est activé. Pour le modèle de la meilleure qualité, nous recommandons de définir should_remesh à false.
S'applique uniquement quand should_remesh = true
Name
topology
Type
string
défaut triangle
Description
Spécifiez la topologie du modèle généré.
Valeurs disponibles :
quad : Génère un maillage dominé par les quads.
triangle : Génère un maillage de triangles 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 varier par rapport à la cible en fonction de la complexité de la géométrie.
La plage de valeurs valides varie en fonction du niveau d'utilisateur :
100 à 300 000 (inclus)
Name
decimation_mode
Type
integer
Description
Active la décimation adaptative en définissant un niveau de nombre de polygones. Lorsqu'il est défini, target_polycount est ignoré.
Valeurs disponibles :
1 : Adaptatif — ultra polycount.
2 : Adaptatif — polycount élevé.
3 : Adaptatif — polycount moyen.
4 : Adaptatif — polycount faible.
Name
save_pre_remeshed_model
Type
boolean
défaut false
Description
Lorsqu'il est défini à true, Meshy stocke également un fichier GLB supplémentaire avant que la phase de Remaillage ne soit complétée.
Name
symmetry_mode
Type
string
⚠ obsolète
défaut auto
Description
Obsolète. Ce paramètre n'affecte plus la sortie.
Le champ symmetry_mode contrôle le comportement de symétrie lors du 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. Si générer le modèle dans une pose A/T.
Name
image_enhancement
Type
boolean
défaut true
Description
Optimise les images d'entrée pour de meilleurs résultats. Réglez sur false pour préserver l'apparence exacte des images d'entrée sans aucun traitement de style.
Supporté uniquement lorsque ai_model est meshy-6, meshy-7 ou latest.
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 sous des configurations d'éclairage personnalisées.
Supporté uniquement lorsque ai_model est meshy-6, meshy-7 ou latest.
Name
moderation
Type
boolean
défaut false
Description
Lorsqu'il est défini à true, le contenu d'entrée sera automatiquement analysé pour contenir potentiellement du contenu nuisible. Si un contenu nuisible est détecté, la tâche ne passera pas à la génération.
Chaque image de image_urls et le texte de texture_prompt seront analysés.
Name
target_formats
Type
string[]
Description
Spécifie quels 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'achèvement de la tâche.
Lorsqu'il est omis, tous les formats sauf 3mf sont générés. 3mf est uniquement inclus lorsqu'il est explicitement spécifié.
Name
auto_size
Type
boolean
défaut false
Description
Lorsqu'il est défini à true, le service utilise la vision AI 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 à moins que origin_at ne soit explicitement défini.
Name
alpha_thumbnail
Type
boolean
défaut false
Description
Lorsqu'il est défini à true, la tâche rend également une version à fond transparent (RGBA) de l'aperçu et la renvoie en tant que alpha_thumbnail_url dans la réponse GET. Le champ thumbnail_url existant est inchangé.
Name
multi_view_thumbnails
Type
boolean
défaut false
Description
Lorsqu'il est défini à true, la tâche rend également quatre miniatures de vue cardinale (avant, droite, arrière, gauche) et les renvoie sous thumbnail_urls dans la réponse GET. Le champ thumbnail_url existant est inchangé et continue de pointer sur la vue avant, afin que les clients existants ne soient pas affectés.
Ajoute environ 3 secondes de latence à la tâche.
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 la tâche nouvellement créée Multi-Image à 3D.
Modes d'échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes communes :
Paramètre manquant : Soit image_urls soit input_task_id doit être fourni.
Tâche d'entrée invalide : Le input_task_id doit faire référence à une tâche Texte en Image, Image en Image, ou variante multi-vue ayant un statut SUCCEEDED.
Nombre d'images invalide : image_urls doit contenir entre 1 et 4 images.
Format d'image invalide : Une ou plusieurs images dans image_urls ne sont pas dans des formats supportés.
URL inaccessible : Une ou plusieurs image_urls n'ont pas pu être téléchargées.
Ce point de terminaison vous permet d'obtenir une tâche Multi-Image à 3D donnée en fournissant un id de tâche valide.
Référez-vous à L'objet de la tâche Multi-Image à 3D pour voir quelles
propriétés sont incluses avec l'objet tâche Multi-Image à 3D.
Ce point de terminaison supprime définitivement une tâche Multi-Image à 3D, y compris tous les modèles associés et les données. Cette action est irréversible.
L'objet de la tâche Multi-Image à 3D est une unité de travail que Meshy utilise pour générer un modèle 3D à partir de plusieurs images (entre 1 à 4 inclus). Les images doivent être du même objet, idéalement de différentes vues ou angles.
L'objet a 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 par k pour les identifiants de tâche en tant que détail d'implémentation, vous ne devriez pas faire d'hypothèses sur le format de l'identifiant.
Name
type
Type
string
Description
Type de la tâche Multi-Image à 3D. La valeur est multi-image-to-3d.
Name
model_urls
Type
object
Description
URL téléchargeable vers le fichier du modèle 3D texturé généré par Meshy. La propriété pour un format sera omise si le format n'est pas généré au lieu de retourner une chaîne vide.
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, retourné avec les exportations 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
pre_remeshed_glb
Type
string
Description
URL téléchargeable vers la sortie GLB originale avant le Remaillage.
Disponible uniquement lorsque la tâche a été créée avec should_remesh: true et save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL téléchargeable vers l'image miniature du fichier modèle. Équivalent à thumbnail_urls.front lorsqu'il est présent, conservé pour la compatibilité avec les versions antérieures.
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
thumbnail_urls
Type
object
Description
URLs téléchargeables pour quatre miniatures de vue cardinale du modèle 3D généré. Chaque valeur est une URL signée vers un PNG 512×512 rendu avec les mêmes matériaux et éclairage que thumbnail_url. Utile pour prévisualiser le modèle sous plusieurs angles dans les pipelines de traitement en lot sans télécharger le GLB.
Présent uniquement lorsque la tâche a été créée avec multi_view_thumbnails: true et a atteint SUCCEEDED. Les anciennes tâches et les tâches créées sans l'option ne comprendront pas ce champ.
Name
front
Type
string
Description
Vue avant, rotation de 0° autour de l'axe vertical (correspond à thumbnail_url).
Name
right
Type
string
Description
Vue droite, rotation de 90°.
Name
back
Type
string
Description
Vue arrière, rotation de 180°.
Name
left
Type
string
Description
Vue gauche, rotation de 270°.
Name
texture_prompt
Type
string
Description
Le prompt textuel qui a été utilisé pour guider le processus de texturation.
Name
progress
Type
integer
Description
Progression de la tâche. Si la tâche n'a pas encore commencé, cette propriété sera 0. Une fois que la tâche a réussi, cela deviendra 100.
Name
started_at
Type
timestamp
Description
Horodatage du moment où la tâche a été commencée, en millisecondes. Si la tâche n'a pas encore commencé, cette propriété sera 0.
Un horodatage représente le nombre de millisecondes écoulées depuis le 1er janvier 1970 UTC, suivant la
norme RFC 3339.
Par exemple, le vendredi 1er septembre 2023 à 12:00:00 GMT est représenté par 1693569600000. Cela s'applique
à tous les horodatages dans Meshy API.
Name
created_at
Type
timestamp
Description
Horodatage du moment où la tâche a été créée, en millisecondes.
Name
expires_at
Type
timestamp
Description
Horodatage du moment où le résultat de la tâche expire, en millisecondes.
Name
finished_at
Type
timestamp
Description
Horodatage du moment où la tâche a été terminée, 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 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Un tableau d'objets URL de texture générés à partir de la tâche. Normalement, cela ne contient qu'un seul objet URL de texture. Chaque URL de texture a 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 carte normale.
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 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 est significative uniquement si 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. Voir 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).