L'API Multi-image en 3D est une fonctionnalité qui vous permet d'intégrer les capacités de Multi-image en 3D 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 Multi-image en 3D. Reportez-vous à
L'objet tâche Multi-image en 3D pour voir quelles
propriétés sont incluses dans l'objet tâche Multi-image en 3D.
Paramètres
Un seul des paramètres input_task_id ou image_urls est requis. Si les deux sont fournis, input_task_id a la priorité.
Name
input_task_id
Type
string
Requis
Description
L'ID d'une tâche de génération 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 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 SUCCEEDED.
Name
image_urls
Type
array
Requis
Description
Fournissez de 1 à 4 images pour que Meshy les utilise dans la création du modèle. Nous prenons actuellement en charge les formats .jpg, .jpeg, et .png. Toutes les images doivent représenter le même objet sous différents angles pour de meilleurs résultats.
Il existe deux façons de fournir chaque image :
URL accessible publiquement : une URL accessible depuis l'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.1 (ou latest), la première image est utilisée comme vue principale (avant). L'ordre des images restantes n'a pas d'importance.
meshy-7 (obsolète) : utilisez meshy-7.1 à la place.
Name
geometry_resolution
Type
string
défaut standard
Description
Passe de génération de la géométrie. 2k exécute la passe Ultra à 2048³. Nécessite meshy-7.1 ou latest.
Valeurs disponibles : standard, 2k
Name
ultra_mode
Type
boolean
⚠ obsolète
défaut false
Description
Utilisez geometry_resolution à la place. ultra_mode: true équivaut à geometry_resolution: "2k".
Name
should_texture
Type
boolean
défaut true
Description
Détermine si les textures sont générées. Le définir sur false ignore la phase de texturation, fournissant un maillage sans textures.
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é, 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.1 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'une des valeurs 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.1 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 — équivaut à texture_resolution: "4k". Lorsque les deux sont définis, texture_resolution a priorité.
Name
texture_prompt
Type
string
Description
Fournissez un prompt textuel pour guider le processus de texturation. Maximum 800 caractères.
Name
texture_image_url
Type
string
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 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 d'image peut ne pas fonctionner de manière optimale s'il existe des différences géométriques importantes entre l'asset d'origine et l'image téléchargée. Un seul des paramètres 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é par défaut pour texturer le modèle.
Name
texture_image_urls
Type
string[]
Description
Fournissez de 1 à 4 images montrant le même objet sous différentes vues pour guider la texturation. La première image est la vue principale (avant) ; l'ordre des vues restantes (gauche, arrière, droite) n'a pas d'importance.
Chaque élément accepte les mêmes formats que texture_image_url (une URL accessible publiquement ou un Data URI en base64, .jpg/.jpeg/.png).
Ces images guident uniquement la texture, et sont indépendantes de image_urls — les deux listes peuvent contenir des images différentes et un nombre différent d'images.
Nécessite ai_modelmeshy-7.1 ou latest. Ne peut pas être combiné avec texture_image_url ou texture_prompt.
Name
should_remesh
Type
boolean
défaut false (Meshy 6 and Meshy 7 models), true (others)
Description
Contrôle l'activation de la phase de remaillage. Pour obtenir un modèle de qualité maximale, nous recommandons de définir should_remesh sur false.
S'applique uniquement quand should_remesh = true
Name
topology
Type
string
défaut triangle
Description
Spécifie la topology du modèle généré.
Valeurs disponibles :
quad : génère un maillage à dominante de quadrilatères.
triangle : génère un maillage triangulaire décimé.
Name
target_polycount
Type
integer
défaut 30,000
Description
Spécifie 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 valides varie selon le niveau utilisateur :
de 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 — nombre de polygones ultra.
2 : adaptatif — nombre de polygones élevé.
3 : adaptatif — nombre de polygones moyen.
4 : adaptatif — nombre de polygones faible.
Name
save_pre_remeshed_model
Type
boolean
défaut false
Description
Lorsqu'il est défini sur true, Meshy stocke également un fichier GLB supplémentaire avant la fin de la phase de remaillage.
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 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 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. Définissez sur false pour conserver l'apparence exacte des images d'entrée sans aucun traitement de style.
Pris en charge uniquement lorsque ai_model est meshy-6, meshy-7.1 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 avec des configurations d'éclairage personnalisées.
Pris en charge uniquement lorsque ai_model est meshy-6, meshy-7.1 ou latest.
Name
moderation
Type
boolean
défaut false
Description
Lorsqu'il est défini sur true, le contenu d'entrée sera automatiquement examiné pour détecter un contenu potentiellement 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 examinés.
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.
Lorsqu'il est omis, tous les formats sauf 3mf sont générés. 3mf n'est inclus que lorsqu'il est explicitement spécifié.
Name
auto_size
Type
boolean
défaut false
Description
Lorsqu'il 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.
Name
alpha_thumbnail
Type
boolean
défaut false
Description
Lorsqu'il est défini sur true, la tâche restitue en plus une version à fond transparent (RGBA) de l'aperçu et la renvoie sous forme de alpha_thumbnail_url dans la réponse GET. Le champ existant thumbnail_url reste inchangé.
Name
multi_view_thumbnails
Type
boolean
défaut false
Description
Lorsqu'il est défini sur true, la tâche restitue en plus quatre vignettes de vues cardinales (avant, droite, arrière, gauche) et les renvoie sous thumbnail_urls dans la réponse GET. Le champ existant thumbnail_url reste inchangé et continue de pointer vers la vue avant, de sorte que les clients existants ne sont pas affectés.
Ajoute environ 3 secondes à la latence de 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 tâche de la tâche Multi-image en 3D nouvellement créée.
Modes d'échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant : image_urls ou input_task_id doit être fourni.
Tâche d'entrée invalide : input_task_id doit faire référence à une tâche Texte en image, Image en image, ou une variante multi-vue avec le statut SUCCEEDED.
Nombre d'images invalide : image_urls doit contenir entre 1 et 4 images, et texture_image_urls entre 1 et 4.
Format d'image invalide : une ou plusieurs images dans image_urls ne sont pas dans des formats pris en charge.
Entrées de texture en conflit : texture_image_urls ne peut pas être combiné avec texture_image_url ou texture_prompt, et nécessite should_texture: true.
Modèle non pris en charge pour la texture multi-vue : texture_image_urls nécessite ai_modelmeshy-7.1 ou latest.
URL inaccessible : un ou plusieurs éléments de image_urls ou texture_image_urls n'ont pas pu être téléchargés.
Résolution non prise en charge pour l'entrée multi-image : geometry_resolution: "4k" n'est pas disponible sur ce point de terminaison ; utilisez 2k ou standard.
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/multi-image-to-3d
# Simple requestcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With Ultra 2K geometry, PBR texturing and GLB formatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "ai_model": "meshy-7.1", "geometry_resolution": "2k", "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Ce point de terminaison vous permet de récupérer une tâche Multi-image en 3D à partir d'un id de tâche valide.
Consultez L'objet de tâche Multi-image en 3D pour voir quelles
propriétés sont incluses dans l'objet de tâche Multi-image en 3D.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche Multi-image en 3D à récupérer.
Ce point de terminaison supprime définitivement une tâche Multi-image en 3D, 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 Multi-image en 3D à 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 pour une tâche
que le worker a déjà commencé à traiter 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 final (SUCCEEDED, FAILED ou CANCELED) est supprimée
sans remboursement.
Retourne
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."}
L'objet tâche Multi-image en 3D est une unité de travail que Meshy suit afin de générer un modèle 3D à partir de plusieurs images (entre 1 et 4 inclus). Les images doivent représenter le même objet, idéalement selon des vues ou angles différents.
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 k-sortable pour les identifiants de tâches 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 Multi-image en 3D. La valeur est multi-image-to-3d.
Name
model_urls
Type
object
Description
URL téléchargeable vers le fichier de 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 renvoyer 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, renvoyée avec les 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ésente uniquement lorsque 3mf a été demandé via target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL téléchargeable vers le fichier GLB original avant le remesh.
Disponible uniquement lorsque la tâche a été créée avec à la fois 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 de modèle. Équivalent à thumbnail_urls.front lorsque présent, conservé pour la rétrocompatibilité.
Name
alpha_thumbnail_url
Type
string
Description
URL téléchargeable vers une version à fond transparent (RGBA) de thumbnail_url. Présente 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 des vues cardinales du modèle 3D généré. Chaque valeur est une URL signée vers un PNG de 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 des pipelines par lots 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 le statut SUCCEEDED. Les tâches plus anciennes et les tâches créées sans cette option ne comportent pas ce champ.
Name
front
Type
string
Description
Vue de face, rotation de 0° autour de l'axe vertical (correspond à thumbnail_url).
Name
right
Type
string
Description
Vue de droite, rotation de 90°.
Name
back
Type
string
Description
Vue de dos, rotation de 180°.
Name
left
Type
string
Description
Vue de gauche, rotation de 270°.
Name
texture_prompt
Type
string
Description
Le prompt textuel qui a été utilisé pour guider le processus de texturage.
Name
texture_image_urls
Type
string[]
Description
URLs téléchargeables vers les images de référence de texture qui ont été utilisées pour créer la tâche, dans l'ordre où elles ont été fournies. Présent uniquement lorsque la tâche a été créée avec texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ obsolète
Description
Obsolète ; utilisez geometry_resolution à la place.
Name
geometry_resolution
Type
string
Description
Le palier Ultra sur lequel la tâche s'est exécutée (2k) ; omis pour standard.
Name
progress
Type
integer
Description
Progression 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, selon
la norme RFC 3339.
Par exemple, le vendredi 1 septembre 2023 à 12:00:00 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é sera 0.
Name
status
Type
string
Description
Statut de la tâche. Les valeurs possibles sont l'une des suivantes : 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, il ne contient qu'un seul objet 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.
La valeur de ce champ n'a de sens que si le statut de la tâche est PENDING.
Name
task_error
Type
object
Description
Détails d'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. Renvoie 0 pour les tâches FAILED (les crédits sont remboursés en cas d'échec).