Transformez une photo source en une figurine 3D collectionnable de style briques en deux étapes :
prototype génère une image conceptuelle stylisée à partir de votre photo d'entrée, puis
build transforme cette image conceptuelle en un modèle 3D texturé. Les deux étapes
sont liées via input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Génère une image de concept unique dans un style briques à partir de la photo source. L'ID de tâche renvoyé est celui que vous transmettez en tant que input_task_id au point de terminaison de construction. Reportez-vous à
L'objet Tâche de prototype de figurine en briques
pour connaître la forme de la réponse.
Paramètres
Name
image_url
Type
string
Requis
Description
Photo source que Meshy doit styliser en minifigurine de briques. Nous prenons actuellement en charge les formats .jpg, .jpeg, .png et .webp.
Il existe deux façons de fournir l'image :
URL accessible publiquement : une URL accessible depuis Internet public.
Data URI : une donnée URI encodée en base64 de l'image. Exemple de data URI : data:image/jpeg;base64,<vos données d'image encodées en base64>.
Name
name
Type
string
Description
Nom de tâche optionnel à des fins d'affichage. Maximum 100 caractères.
Name
remove_background
Type
boolean
défaut false
Description
Lorsque défini à true, l'image du prototype est renvoyée sous forme de PNG RGBA transparent avec l'arrière-plan supprimé, afin que vous puissiez composer le sujet sur n'importe quel arrière-plan.
Retours
La propriété result de la réponse contient l'id de la tâche de la tâche de prototype de figurine en briques nouvellement créée. Interrogez le point de terminaison Obtenir une tâche ou abonnez-vous au flux jusqu'à ce que la tâche atteigne SUCCEEDED, puis transmettez cet ID au point de terminaison de construction en tant que input_task_id.
Modes d'échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant : image_url est requis.
Format d'image invalide : l'image_url fourni n'est pas dans un format pris en charge (.jpg, .jpeg, .png, .webp).
Dimensions d'image hors limites : l'image est trop petite, dépasse la taille de fichier maximale, ou dépasse le nombre maximal de pixels.
URL inaccessible : l'image_url n'a pas pu être téléchargé (404 ou timeout).
Data URI invalide : la chaîne base64 est malformée.
Contenu signalé : l'image d'entrée a été signalée par la moderation NSFW.
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
403 - Forbidden
Description
L'image d'entrée a été signalée pour violation de propriété intellectuelle.
Name
429 - Too Many Requests
Description
Vous avez dépassé votre limite de débit.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Génère la figurine en briques 3D texturée finale à partir d'une tâche de prototype réussie. Le build exécute le même pipeline image-vers-3D que
Image en 3D, donc le format de l'objet de réponse et la
liste des URL de sortie correspondent exactement. Reportez-vous à
L'objet Tâche de Build de Figurine en Briques pour la
forme de la réponse.
Paramètres
Name
input_task_id
Type
string
Requis
Description
L'ID de tâche d'une tâche de prototype créée via ce même point de terminaison OpenAPI. Le prototype doit avoir été créé avec la même clé API, doit avoir atteint SUCCEEDED, et doit avoir produit exactement une image candidate.
Les tâches de prototype créées via l'application web ne sont pas acceptées — le point de terminaison de build accepte uniquement les tâches de prototype produites par POST /openapi/creative-lab/brick-figure/v1/prototype et refuse toute autre source avec 404.
Name
name
Type
string
Description
Nom de tâche optionnel à des fins d'affichage. Maximum 100 caractères.
Retours
La propriété result de la réponse contient l'id de tâche de la tâche de build de figurine en briques nouvellement créée. Interrogez le point de terminaison Récupérer une tâche ou abonnez-vous au flux jusqu'à ce que la tâche atteigne SUCCEEDED, puis téléchargez le GLB texturé depuis model_urls.glb (ou la paire OBJ + MTL depuis model_urls.obj et model_urls.mtl si votre pipeline en aval préfère OBJ).
Modes d'échec
Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
Paramètre manquant : input_task_id est requis.
UUID invalide : Le input_task_id n'est pas un UUID valide.
Parent non réussi : La tâche de prototype référencée n'a pas encore atteint SUCCEEDED.
Aucun candidat : La tâche de prototype a réussi mais n'a produit aucune image candidate.
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 prototype référencée n'existe pas, appartient à un autre utilisateur, ou a été créée via l'application web (seules les tâches de prototype en mode API s'enchaînent vers le build).
Name
429 - Too Many Requests
Description
Vous avez dépassé votre limite de débit.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Récupère une tâche de prototype ou de build à partir d'un id de tâche valide. Le chemin de l'URL
doit correspondre à l'étape de la tâche — une tâche de build récupérée via
/prototype/:id renvoie 404, et inversement.
Annule une tâche de figurine en briques. Si la tâche est encore en état
PENDING, les crédits consommés lors de la création sont remboursés. Les
tâches déjà IN_PROGRESS sont annulées sans remboursement (le worker est
peut-être déjà en train de consommer des ressources). Les tâches ayant
déjà atteint un état final (SUCCEEDED, FAILED, CANCELED) ne peuvent
pas être annulées.
Le chemin de l'URL doit correspondre à l'étape de la tâche — un DELETE
sur /prototype/:buildId renvoie 404.
Paramètres de chemin
Name
id
Type
path
Description
Identifiant unique de la tâche de figurine en briques à annuler.
Retours
Retourne 204 No Content en cas de succès avec un corps vide.
Modes d'échec
Name
400 - Bad Request
Description
La tâche est déjà dans un état final et ne peut pas être annulée.
Name
404 - Not Found
Description
La tâche n'existe pas, appartient à un autre utilisateur, ou son étape ne correspond pas au chemin de l'URL.
Diffuse en continu les mises à jour en temps réel d'une tâche de figurine en briques via Server-Sent Events (SSE).
Le chemin de l'URL doit correspondre à l'étape de la tâche — ouvrir un flux à
/prototype/:buildId/stream émet une seule charge utile event: error avec
status_code: 404 puis ferme le flux.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche de figurine en briques à diffuser en continu.
Retours
Retourne un flux d'objets de tâche Brick Figure Prototype
ou Brick Figure Build sous forme de
Server-Sent Events. Chaque trame transporte l'objet de tâche complet correspondant à l'étape — la même forme que celle renvoyée par le
point de terminaison Get — ainsi, tant que la tâche est PENDING ou IN_PROGRESS, les
champs de sortie ne sont simplement pas encore renseignés (null, [] ou {}) et
finished_at vaut null.
Récupérez une liste paginée de vos tâches de figurine en briques pour une seule étape. Le chemin
d'URL sélectionne l'étape — /prototype renvoie les tâches de prototype ;
/build renvoie les tâches de construction. Les tâches de l'autre étape ne sont incluses
dans aucune des deux réponses.
Paramètres de chemin
Name
stage
Type
path
Requis
Description
Soit prototype, soit build. La collection ne renvoie que les tâches
dont l'étape correspond à l'URL — récupérer /prototype ne renvoie jamais des
tâches de construction, et inversement.
Paramètres de requête
Name
page_num
Type
integer
défaut 1
Description
Numéro de page pour la pagination.
Name
page_size
Type
integer
défaut 10
Description
Limite de taille de page. Le maximum autorisé est de 100 éléments.
Name
sort_by
Type
string
défaut -created_at
Description
Champ à utiliser pour le tri. Valeurs disponibles :
+created_at : Trier par heure de création en ordre croissant.
-created_at : Trier par heure de création en ordre décroissant.
L'objet Tâche de Prototype de Figurine en Briques est une unité de travail que Meshy suit
pour générer une image conceptuelle de style briques à partir d'une photo source. Le résultat de
cette étape est enchaîné à l'étape de construction
via input_task_id.
Propriétés
Name
id
Type
string
Description
Identifiant unique de la tâche. Bien que nous utilisions un UUID k-triable pour les identifiants de tâches comme détail d'implémentation, vous ne devez faire aucune supposition quant au format de l'id.
Name
type
Type
string
Description
Type de la tâche. La valeur est creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Le nom de la tâche fourni lors de la création de la tâche. Chaîne vide si aucun nom n'a été fourni.
Name
status
Type
string
Description
Statut de la tâche. Les valeurs possibles sont PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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
created_at
Type
timestamp
Description
Horodatage de la création de la tâche, en millisecondes.
Un horodatage représente le nombre de millisecondes écoulées depuis le 1er janvier 1970 UTC, en suivant
la norme RFC 3339.
Par exemple, le vendredi 1er septembre 2023 à 12h00:00 GMT est représenté par 1693569600000. Cela s'applique
à tous les horodatages de Meshy API.
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 null.
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 null.
Name
expires_at
Type
timestamp
Description
Horodatage de l'expiration du résultat de la tâche, en millisecondes.
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. 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).
Name
image_urls
Type
array of strings
Description
URL téléchargeables pour les candidats d'image conceptuelle générés par cette tâche de prototype. Actuellement, l'API renvoie toujours exactement un candidat ; ce champ est un tableau afin que de futures révisions puissent proposer plusieurs candidats sans rupture de compatibilité.
L'objet Brick Figure Build Task est une unité de travail que Meshy suit pour
générer une figurine en briques 3D texturée à partir d'une tâche de prototype réussie. Elle
exécute le même pipeline image-en-3D utilisé par Image en 3D,
c'est pourquoi les champs de sortie reflètent l'objet de tâche de ce point de terminaison.
Propriétés
Name
id
Type
string
Description
Identifiant unique de la tâche.
Name
type
Type
string
Description
Type de la tâche. La valeur est creative-lab-brick-figure-build.
Name
name
Type
string
Description
Le nom de la tâche fourni lors de sa création. Chaîne vide si aucun nom n'a été fourni.
Name
status
Type
string
Description
Statut de la tâche. Les valeurs possibles sont PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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
created_at
Type
timestamp
Description
Horodatage de la création de la tâche, en millisecondes.
Name
started_at
Type
timestamp
Description
Horodatage du démarrage de la tâche, en millisecondes.
Name
finished_at
Type
timestamp
Description
Horodatage de la fin 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
preceding_tasks
Type
integer
Description
Le nombre de tâches précédentes. Pertinent uniquement lorsque le statut 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. Renvoie 0 pour les tâches FAILED (les crédits sont remboursés en cas d'échec).
Name
prompt
Type
string
Description
Toujours vide pour la construction de figurine en briques. Présent pour la compatibilité entre points de terminaison avec le format partagé V2ImageTo3DTaskResponse utilisé par Image en 3D.
Name
negative_prompt
Type
string
Description
Toujours vide pour la construction de figurine en briques. Présent pour la compatibilité entre points de terminaison.
Name
texture_prompt
Type
string
Description
Toujours vide pour la construction de figurine en briques. Présent pour la compatibilité entre points de terminaison.
Name
texture_image_url
Type
string
Description
Toujours vide pour la construction de figurine en briques. Présent pour la compatibilité entre points de terminaison.
Name
model_urls
Type
object
Description
URL téléchargeables pour le modèle 3D généré. La construction de figurine en briques produit un fichier GLB texturé ainsi que la paire OBJ + MTL pour les pipelines qui préfèrent le format Wavefront OBJ. La structure de ce champ correspond à l'objet Image to 3D model_urls afin que les futurs ajouts de formats s'intègrent sans rupture de compatibilité.
Name
glb
Type
string
Description
URL téléchargeable vers le fichier GLB texturé.
Name
obj
Type
string
Description
URL téléchargeable vers le fichier Wavefront OBJ (géométrie + UV).
Name
mtl
Type
string
Description
URL téléchargeable vers le fichier matériau MTL compagnon du OBJ. À associer avec obj et l'entrée de texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL téléchargeable vers la miniature du fichier du modèle.
Name
texture_urls
Type
array
Description
Un tableau d'objets d'URL de texture générés par cette tâche. Contient actuellement un seul objet avec la carte de couleur de base.
Name
base_color
Type
string
Description
URL téléchargeable vers l'image de la carte de couleur de base.