L’API Image en 3D est une fonctionnalité qui vous permet d’intégrer les capacités Image 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.
Ce point de terminaison vous permet de créer une nouvelle tâche Image en 3D. Consultez
L’objet de tâche Image en 3D pour voir quelles
propriétés sont incluses dans l’objet de tâche Image en 3D.
Paramètres
Un seul de input_task_id ou image_url est requis. Si les deux sont fournis, input_task_id est prioritaire.
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 doit être utilisée comme image d’entrée. Cette tâche doit être l’une des tâches suivantes : Texte en image ou Image en image. De plus, elle doit avoir été exécutée via l’API, avoir un statut SUCCEEDED et produire exactement une image.
Name
image_url
Type
string
Requis
Description
Fournissez une image que Meshy utilisera pour la création du modèle. 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>.
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 avec un niveau de détail élevé.
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, save_pre_remeshed_model 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_texture
Type
boolean
défaut true
Description
Détermine si des textures sont générées. Le définir sur false ignore la phase de texture, fournissant un maillage sans textures.
S'applique uniquement quand should_texture = true
Name
enable_pbr
Type
boolean
défaut false
Description
Générez 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érez la texture de couleur de base en résolution 4K (4096×4096) pour plus de détails.
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 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 par image peut ne pas fonctionner de manière optimale s’il existe des différences substantielles de géométrie entre l’asset d’origine et l’image téléversée. Un seul de 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. Le texturage via du texte ou une image coûtera 10 crédits par tâche.
Name
should_remesh
Type
boolean
défaut false (meshy-6), true (others)
Description
Contrôle l’activation de la phase de remaillage. Lorsqu’il est défini sur false, l’API renvoie le maillage triangulaire de 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 principalement composé de quadrilatères.
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. Lorsqu’il 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 — faible nombre de polygones.
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 (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 dans une pose A/T.
Name
image_enhancement
Type
boolean
défaut true
Description
Optimise l’image d’entrée pour de meilleurs résultats. Définissez sur false pour préserver l’apparence exacte de l’image d’entrée sans aucun traitement de style.
Pris en charge uniquement lorsque ai_model est meshy-6 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 ou latest.
Name
moderation
Type
boolean
défaut false
Description
Lorsqu’il est défini sur true, le contenu d’entrée sera automatiquement contrôlé afin de détecter tout contenu potentiellement dangereux. Si un contenu dangereux est détecté, la tâche ne passera pas à la génération.
Le contenu provenant des entrées image_url, texture_image_url et texture_prompt sera contrôlé.
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 finalisation 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
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 définie par défaut sur 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 rend en plus une version à arrière-plan transparent (RGBA) de l’aperçu et la renvoie sous forme de alpha_thumbnail_url dans la réponse GET. Le champ thumbnail_url existant reste inchangé.
Name
multi_view_thumbnails
Type
boolean
défaut false
Description
Lorsqu’il est défini sur true, la tâche rend en plus quatre miniatures de vues cardinales (avant, droite, arrière, gauche) et les renvoie sous thumbnail_urls dans la réponse GET. Le champ thumbnail_url existant reste inchangé et continue de pointer vers la vue de face, 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 nouvelle tâche Image en 3D créée.
Modes d’échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant : image_url ou input_task_id doit être fourni.
Tâche d’entrée non valide : input_task_id doit faire référence à une tâche Texte en image ou Image en image SUCCEEDED qui produit exactement une image.
Format d’image non valide : le image_url fourni n’est pas dans un format pris en charge (.jpg, .jpeg, .png).
URL inaccessible : le image_url n’a pas pu être téléchargé (404 ou timeout).
Data URI non valide : la chaîne base64 est mal formée.
Combinaison de paramètres non valide : enable_pbr est pris en charge uniquement lorsque should_texture est true.
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/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Ce point de terminaison vous permet de récupérer une tâche Image en 3D à partir d’un id de tâche valide.
Consultez L’objet de tâche Image en 3D pour voir quelles
propriétés sont incluses dans l’objet de tâche Image en 3D.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche Image en 3D à récupérer.
Retours
La réponse contient l’objet de tâche Image en 3D. Consultez la section
L’objet de tâche Image en 3D pour plus de détails.
L’objet de tâche Image en 3D est une unité de travail que Meshy suit pour générer un modèle 3D à partir d’une entrée image.
L’objet possède les propriétés suivantes :
Properties
Name
id
Type
string
Description
Identifiant unique de la tâche. Bien que nous utilisions un UUID triable 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 Image en 3D. La valeur est 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é 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 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é 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 d’origine avant le remaillage.
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 lorsqu’il est présent, conservé pour la rétrocompatibilité.
Name
alpha_thumbnail_url
Type
string
Description
URL téléchargeable vers une version à arrière-plan 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
URL téléchargeables pour quatre miniatures en vues cardinales 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 le même é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 SUCCEEDED. Les tâches plus anciennes et les tâches créées sans l’activation explicite n’incluront 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 arrière, 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_url
Type
string
Description
URL téléchargeable vers l’image de texture qui a été utilisée pour guider le processus de texturage.
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, conformément
à 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 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 d’URL de texture générés à partir de 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 map de couleur de base.
Name
metallic
Type
string
Description
URL téléchargeable vers l’image de la 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 vers 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 vers l’image de la 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 vers l’image de la 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’est significative 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 é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).