Transformez vos photos en aimants de frigo personnalisés — un relief de
profondeur colorisé en rectangle arrondi avec un dos magnétique plat, dimensionné
pour le frigo — en deux étapes : prototype génère une image conceptuelle
colorisée à partir de votre photo d’entrée, puis build transforme cette image
conceptuelle en modèle 3D en relief. Les deux étapes sont liées via
input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Générez une image conceptuelle colorisée unique à partir de la photo source. L’ID de tâche
renvoyé est celui que vous transmettez comme input_task_id au point de terminaison de
construction. Consultez
L’objet de tâche de prototype d’aimant de frigo
pour la structure de la réponse.
Paramètres
Name
image_url
Type
string
Requis
Description
Photo source que Meshy doit coloriser en image conceptuelle prête pour un aimant de frigo. 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 l’internet public.
Data URI : un Data URI encodé en base64 de l’image. Exemple de Data URI : data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nom de tâche facultatif à 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 nouvelle tâche de prototype d’aimant de frigo 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 comme 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 plage : l’image est trop petite, dépasse la taille maximale de fichier ou dépasse le nombre maximal de pixels.
URL inaccessible : l’image_url n’a pas pu être téléchargée (404 ou timeout).
Data URI invalide : la chaîne base64 est mal formée.
Contenu signalé : l’image d’entrée a été signalée par la moderation NSFW ou de propriété intellectuelle.
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/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype \ -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>" }'
Response
{"result":"01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Générez l’aimant de frigo final imprimable en 3D à partir d’une tâche de
prototype réussie. Le build exécute un pipeline de relief par carte de
profondeur sur l’image concept colorisée du prototype et fournit un artefact
de maillage unique dans le format que vous demandez. Consultez
L’objet Fridge Magnet Build Task pour la
structure 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/fridge-magnet/v1/prototype et refuse toute autre source avec 404.
Name
name
Type
string
Description
Nom de tâche facultatif à des fins d’affichage. Maximum 100 caractères.
options
Paramètres de réglage facultatifs pour la géométrie du relief. Chaque champ possède une valeur par défaut raisonnable — envoyez uniquement ceux que vous souhaitez remplacer.
Name
badge_shape
Type
string
défaut rounded-rect
Description
Silhouette de contour de l’aimant de frigo. Valeurs disponibles :
circle
rounded-rect (par défaut)
hexagon
shield
star
Name
size_mm
Type
number
défaut 60
Description
Longueur du côté du carré englobant de l’aimant de frigo, en millimètres. Plage : (0, 400].
Name
relief_height_mm
Type
number
défaut 3.3
Description
Hauteur maximale du relief au-dessus de la base, en millimètres. Plage : [0, 20].
Name
relief_offset_mm
Type
number
défaut 0
Description
Décalage vertical appliqué au relief avant l’extrusion, en millimètres. Plage : [0, 20].
Name
base_thickness_mm
Type
number
défaut 2.0
Description
Épaisseur de la plaque de base plate derrière le relief, en millimètres. La valeur par défaut de l’aimant de frigo est une base plus épaisse de 2 mm — elle donne à l’aimant suffisamment de corps pour adhérer au frigo sans que le relief paraisse fragile. Plage : [0, 20].
Name
has_closed_back
Type
boolean
défaut true
Description
Indique si l’arrière de l’aimant de frigo est scellé en tant que surface fermée (le côté sur lequel vous collez l’aimant). Définissez sur false pour une coque ouverte.
Name
relief_curve
Type
string
défaut linear
Description
Courbe de transfert mappant les valeurs de carte de profondeur à la hauteur du relief. Valeurs disponibles :
linear (par défaut)
gamma
s-curve
Name
curve_param
Type
number
défaut 1.0
Description
Paramètre de forme pour la courbe de transfert (significatif uniquement lorsque relief_curve est gamma). Plage : (0, 10].
Name
invert_depth
Type
boolean
défaut false
Description
Inverse l’interprétation de la carte de profondeur afin que les régions plus sombres deviennent un relief plus haut.
Name
smoothing
Type
number
défaut 0.24
Description
Intensité de lissage appliquée à la carte de profondeur avant l’extraction du relief. Plage : [0, 10].
Name
relief_scale
Type
number
défaut 1.0
Description
Multiplicateur d’échelle verticale appliqué en plus de relief_height_mm. Plage : (0, 10].
Name
depth_threshold
Type
number
défaut 0.1
Description
Seuil passe-bas pour les valeurs de carte de profondeur ; tout ce qui est en dessous est limité à zéro. Plage : [0, 1].
Name
remove_background
Type
boolean
défaut true
Description
Supprime automatiquement l’arrière-plan de l’image concept du prototype avant la création du relief.
Name
export_resolution
Type
integer
défaut 512
Description
Résolution de maillage utilisée pour l’exportation. Plage : [64, 2048].
output
Sélecteur facultatif du format de transmission. La valeur par défaut est glb.
Name
format
Type
string
défaut glb
Description
Bundle d’artefacts renvoyé par le build. Valeurs disponibles :
glb (par défaut) — renvoie un seul model.glb sous model_urls.glb.
obj — compresse model.obj + model.mtl + texture.png et renvoie le bundle sous model_urls.obj.
zip — compresse chaque artefact émis par le générateur et renvoie le bundle sous model_urls.bundle_zip.
Retours
La propriété result de la réponse contient l’id de tâche de la nouvelle tâche de build d’aimant de frigo créée. Interrogez le point de terminaison Get a Task ou abonnez-vous au stream jusqu’à ce que la tâche atteigne SUCCEEDED, puis téléchargez l’artefact depuis l’entrée unique dans model_urls.
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 : 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.
Options hors plage : l’un des champs options est sorti de sa plage autorisée ou de son ensemble d’énumération.
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 peuvent être enchaînées dans le build).
Récupérez une tâche de prototype ou de build à partir d’un id de tâche valide. Le chemin d’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.
Annulez une tâche d'aimant de frigo. Si la tâche est encore PENDING, les crédits
consommés au moment de la création sont remboursés. Les tâches déjà
IN_PROGRESS sont annulées sans remboursement (le worker consomme peut-être déjà des
ressources). Les tâches qui ont déjà atteint un état terminal
(SUCCEEDED, FAILED, CANCELED) ne peuvent pas être annulées.
Le chemin de l'URL doit correspondre à l'étape de la tâche — DELETE sur
/prototype/:buildId renvoie 404.
Paramètres de chemin
Name
id
Type
path
Description
Identifiant unique de la tâche d'aimant de frigo à annuler.
Retours
Renvoie 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 terminal 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.
Diffusez en temps réel les mises à jour d’une tâche d’aimant de frigo via Server-Sent Events (SSE).
Le chemin de l’URL doit correspondre à l’étape de la tâche — ouvrir un flux sur
/prototype/:buildId/stream émet une seule charge utile event: error avec
status_code: 404 et ferme le flux.
Paramètres
Name
id
Type
path
Description
Identifiant unique de la tâche d’aimant de frigo à diffuser en flux.
Retours
Retourne un flux d’objets de tâche Prototype d’aimant de frigo
ou Build d’aimant de frigo sous forme de
Server-Sent Events. Pour les tâches PENDING ou IN_PROGRESS, le flux de réponse
inclura uniquement les champs progress et status nécessaires.
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","type": "creative-lab-fridge-magnet-build","status": "SUCCEEDED","progress": 100,"created_at": 1729543250000,"started_at": 1729543258000,"finished_at": 1729543285000,"expires_at": 1729802485000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
Récupérez une liste paginée de vos tâches d’aimant de frigo pour une seule étape. Le chemin
de l’URL sélectionne l’étape — /prototype renvoie les tâches de prototype ; /build
renvoie les tâches de build. Les tâches de l’autre étape ne sont incluses dans aucune des
réponses.
Paramètres de chemin
Name
stage
Type
path
Requis
Description
Soit prototype, soit build. La collection renvoie uniquement les tâches
dont l’étape correspond à l’URL — récupérer /prototype ne renvoie jamais
de tâches de build, 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 50 éléments.
Name
sort_by
Type
string
défaut -created_at
Description
Champ selon lequel trier. Valeurs disponibles :
+created_at: Trier par heure de création dans l’ordre croissant.
-created_at: Trier par heure de création dans l’ordre décroissant.
L’objet de tâche de prototype d’aimant de frigo est une unité de travail que Meshy suit pour
générer une image conceptuelle colorisée à partir d’une photo source. La sortie de
cette étape est enchaînée dans 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 triable par k pour les identifiants de tâche comme détail d’implémentation, vous ne devez faire aucune supposition sur le format de l’identifiant.
Name
type
Type
string
Description
Type de la tâche. La valeur est creative-lab-fridge-magnet-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 l’une de PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress de la tâche. Si la tâche n’est pas encore démarrée, cette propriété sera 0. Une fois la tâche réussie, elle deviendra 100.
Name
created_at
Type
timestamp
Description
Horodatage du moment où la tâche a été créée, en millisecondes.
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
started_at
Type
timestamp
Description
Horodatage du moment où la tâche a démarré, en millisecondes. Si la tâche n’est pas encore démarrée, cette propriété sera 0.
Name
finished_at
Type
timestamp
Description
Horodatage du moment où la tâche s’est terminée, en millisecondes. Si la tâche n’est pas encore terminée, cette propriété sera 0.
Name
expires_at
Type
timestamp
Description
Horodatage du moment où le résultat de la tâche expire, 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. 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. 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 ; le champ est un tableau afin que les révisions futures puissent exposer plusieurs candidats sans changement incompatible.
L’objet tâche de création d’aimant de frigo est une unité de travail que Meshy suit afin de
générer le maillage 3D final d’aimant de frigo à partir d’une tâche de prototype réussie. La
création exécute un pipeline de relief par carte de profondeur sur l’image conceptuelle du prototype et
publie un artefact de maillage unique dans le format demandé par l’appelant.
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-fridge-magnet-build.
Name
name
Type
string
Description
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 l’une de 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
model_urls
Type
object
Description
URL téléchargeables pour l’artéfact généré, indexées par nom d’artéfact. Contient toujours exactement une entrée — le format demandé via le output.format de la requête de build. La clé correspond au format demandé :
Name
glb
Type
string
Description
URL téléchargeable vers le fichier GLB. Présente lorsque output.format était glb (valeur par défaut).
Name
obj
Type
string
Description
URL téléchargeable vers un bundle zip contenant model.obj, model.mtl et texture.png. Présente lorsque output.format était obj.
Name
bundle_zip
Type
string
Description
URL téléchargeable vers un bundle zip de chaque artéfact émis par le générateur. Présente lorsque output.format était zip.