API Creative Lab Keychain

Transformez une photo en porte-clés imprimable en 3D avec un relief coloré en deux étapes. Une tâche de prototype génère une image conceptuelle colorisée à partir de la photo. Une tâche de build transforme cette image en un modèle 3D en relief, et prend l'ID de la tâche de prototype comme input_task_id.

POST /openapi/creative-lab/keychain/v1/prototype
POST /openapi/creative-lab/keychain/v1/build

POST/openapi/creative-lab/keychain/v1/prototype

Créer une tâche de prototype Keychain

Génère une image conceptuelle colorisée à partir d'une photo. Pour construire le modèle 3D, transmettez l'ID de cette tâche au point de terminaison de build en tant que input_task_id. Pour les champs de la tâche, voir L'objet tâche de prototype Keychain.

Request

POST

/openapi/creative-lab/keychain/v1/prototype

# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

Prototype example

Start with a source photo, then generate the prototype image used by the keychain build stage.

Source photo used as the Creative Lab Keychain input — Prototype input

Creative Lab Keychain prototype output generated from the source photo — Prototype output

Paramètres

Name
image_url
Type
string
Requis
Description
La photo à transformer en image conceptuelle de porte-clés, sous forme d'URL publique ou de Data URI (data:image/jpeg;base64,<vos données d'image encodées en base64>).
L'image doit être un fichier JPG, JPEG, PNG ou WebP de 20 Mo maximum.
Name
name
Type
string
Description
Un nom pour la tâche, jusqu'à 100 caractères. Il est renvoyé dans le champ name de la tâche. Un nom plus long renvoie 400.
Il identifie la tâche dans votre tableau de bord et vos listes de tâches, et n'apparaît pas sur le porte-clés. Pour inscrire un nom sur le porte-clés, utilisez name_text.
Name
name_text
Type
string
Description
Un nom à ajouter sur le porte-clés, comme celui d'un animal de compagnie ou d'une personne, jusqu'à 10 caractères. Meshy compte les caractères, pas les octets, donc un nom chinois, japonais ou coréen de 10 caractères convient. Un nom plus long renvoie 400. Omettez-le pour un porte-clés sans nom.
Le nom apparaît sur la face du porte-clés sous forme de détail coloré plat, et non en texte en relief ou découpé.
Meshy supprime les espaces superflus et retire les caractères de formatage invisibles. L'objet tâche de prototype renvoie le résultat sous name_text, afin que vous puissiez vérifier le texte avant de payer le build.
Meshy ajoute le nom à l'étape du prototype. Le build le conserve, et ignore tout name_text envoyé au point de terminaison de build.
Lorsque le texte n'est pas en ASCII pur, envoyez le corps de la requête en UTF-8 avec Content-Type: application/json; charset=utf-8. Certains clients HTTP, comme Invoke-RestMethod de Windows PowerShell, encodent le corps en ISO-8859-1 par défaut. Cela transforme chaque caractère non latin en ? avant que la requête n'atteigne Meshy, et Meshy ne peut pas le distinguer d'un nom que vous vouliez réellement envoyer.
Name
remove_background
Type
boolean
défaut false
Description
Indique s'il faut retirer l'arrière-plan de l'image de prototype. true renvoie un PNG RGBA transparent qui conserve le médaillon entier, afin que vous puissiez le placer sur n'importe quel arrière-plan. Le build part également de l'image sans son arrière-plan. Si Meshy ne parvient pas à retirer l'arrière-plan, il renvoie l'image avec son arrière-plan, et la tâche réussit quand même.
L'option remove_background du build est indépendante.

Retours

Le champ result contient l'ID de la nouvelle tâche de prototype. Récupérez la tâche ou diffusez-la jusqu'à ce que status soit SUCCEEDED. Transmettez ensuite l'ID au point de terminaison de build en tant que input_task_id.

Modes d'échec

Name
400 - Bad Request
Description
La requête ne peut pas s'exécuter. Par exemple :
- image_url est manquant.
- L'image n'est pas un fichier JPG, JPEG, PNG ou WebP.
- L'image est trop petite, dépasse 20 Mo, ou dépasse le nombre de pixels maximum.
- Meshy ne parvient pas à télécharger l'image, par exemple parce que l'URL renvoie 404 ou expire.
- Le Data URI n'est pas un base64 valide.
- name_text dépasse 10 caractères. Meshy le rejette plutôt que de le raccourcir, et ne facture pas la requête.
- L'image ou name_text a été signalé comme NSFW.
Le message d'erreur indique le problème trouvé. Corrigez la requête, puis renvoyez-la.
Name
401 - Unauthorized
Description
La clé API est manquante ou invalide. Vérifiez l'en-tête Authorization.
Name
402 - Payment Required
Description
L'un des cas suivants s'applique :
- Le compte n'a pas assez de crédits.
- La clé API, l'espace de travail ou le membre a atteint sa limite de crédits.
- Le compte est sur le plan gratuit.
Vérifiez vos crédits et votre plan, puis réessayez.
Name
403 - Forbidden
Description
Votre équipe a activé le filtrage IP, et Meshy a signalé l'image pour propriété intellectuelle tierce. Envoyez une image dont vous détenez les droits d'utilisation. Meshy ne vérifie que l'image pour la propriété intellectuelle, pas name_text.
Name
429 - Too Many Requests
Description
L'une de ces limites a été atteinte :
- Vous avez envoyé plus de requêtes que ne le permet votre limite de débit. Attendez quelques secondes, puis réessayez. Voir Limites de débit.
- Trop de vos tâches sont en file d'attente ou en cours d'exécution. Attendez que certaines se terminent, puis réessayez.
- Sur un plan illimité sans crédits restants, vous avez atteint le nombre de tâches pouvant s'exécuter sans crédits. Attendez qu'une tâche se termine, ou ajoutez des crédits.
Name
500 - Internal Server Error
Description
Meshy a rencontré une erreur serveur, par exemple parce qu'il n'a pas pu exécuter la vérification de propriété intellectuelle sur l'image. Meshy ne crée pas la tâche, et rembourse tous les crédits facturés. Réessayez la requête.

POST/openapi/creative-lab/keychain/v1/build

Créer une tâche de build Keychain

Génère le porte-clés imprimable en 3D à partir d'une tâche de prototype réussie. Meshy transforme l'image conceptuelle du prototype en relief de carte de profondeur, et renvoie un fichier de modèle dans le format de votre choix. Pour connaître les champs de la tâche, voir L'objet de tâche de build Keychain.

Request

POST

/openapi/creative-lab/keychain/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain build model preview — Build model preview

Paramètres

Name
input_task_id
Type
string
Requis
Description
L'ID de la tâche de prototype à construire. Il doit s'agir d'une tâche créée par votre compte avec POST /openapi/creative-lab/keychain/v1/prototype, avec le statut SUCCEEDED.
Un ID qui ne correspond pas à l'une de vos tâches de prototype Keychain provenant de l'API renvoie 404, y compris un prototype créé dans l'application web.
Name
name
Type
string
Description
Un nom pour la tâche, jusqu'à 100 caractères. Il est renvoyé dans le champ name de la tâche. Un nom plus long renvoie 400.

`options`

Paramètres facultatifs pour la forme du relief. Chaque champ a une valeur par défaut, donc n'envoyez que ceux que vous voulez modifier. Une valeur en dehors de la plage d'un champ renvoie 400.

Name
badge_shape
Type
string
défaut circle
Description
Le contour du porte-clés lorsque Meshy ne le trace pas à partir du sujet. Meshy l'utilise lorsque remove_background est false, ou lorsqu'il ne parvient pas à trouver le contour du sujet.
Valeurs disponibles :
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
défaut 40
Description
La longueur du côté du carré englobant du porte-clés, en millimètres, jusqu'à 400. 0 utilise la valeur par défaut.
Name
relief_height_mm
Type
number
défaut 2.2
Description
La hauteur maximale du relief au-dessus de la base, en millimètres, de 0 à 20.
Name
relief_offset_mm
Type
number
défaut 0
Description
De combien abaisser le relief, en millimètres, de 0 à 20. Meshy le soustrait de la hauteur du relief partout, jusqu'à la base.
Name
base_thickness_mm
Type
number
défaut 0.1
Description
L'épaisseur de la plaque de base plate derrière le relief, en millimètres, de 0 à 20.
Name
has_closed_back
Type
boolean
défaut true
Description
Si l'arrière du porte-clés doit être fermé. false laisse l'arrière ouvert, comme une coquille.
Name
relief_curve
Type
string
défaut linear
Description
La courbe qui associe les valeurs de la carte de profondeur à la hauteur du relief.
Valeurs disponibles :
- linear
- gamma
- s-curve
Name
curve_param
Type
number
défaut 1.0
Description
L'intensité de la courbe, jusqu'à 10. Les courbes gamma et s-curve l'utilisent, et linear l'ignore. 0 utilise la valeur par défaut.
Name
invert_depth
Type
boolean
défaut false
Description
S'il faut inverser la carte de profondeur, de sorte que les zones plus sombres deviennent un relief plus élevé.
Name
smoothing
Type
number
défaut 0.24
Description
Le degré de lissage à appliquer à la carte de profondeur avant que Meshy ne construise le relief, de 0 à 10.
Name
relief_scale
Type
number
défaut 1.0
Description
De combien zoomer le relief et sa texture à l'intérieur du contour, autour du centre, jusqu'à 10. Une valeur supérieure à 1 agrandit le sujet, et une valeur inférieure à 1 le réduit. Cela ne change pas la hauteur du relief. 0 utilise la valeur par défaut.
Name
depth_threshold
Type
number
défaut 0.1
Description
La valeur de la carte de profondeur en dessous de laquelle Meshy fixe la profondeur à zéro, de 0 à 1.
Name
remove_background
Type
boolean
défaut true
Description
S'il faut tracer le contour du porte-clés à partir du sujet, de sorte que le porte-clés suive la forme du sujet. false utilise à la place le contour badge_shape. Meshy utilise aussi badge_shape lorsqu'il ne parvient pas à trouver le contour du sujet.
Ceci est distinct du paramètre remove_background du prototype, qui définit si l'image du prototype a un arrière-plan transparent.
Name
export_resolution
Type
integer
défaut 512
Description
La résolution du maillage du modèle exporté, de 64 à 512. Meshy construit la géométrie à partir d'une carte de profondeur de 512 pixels, donc un maillage plus fin ajouterait des faces sans ajouter de détails. 0 utilise la valeur par défaut.

`output`

Facultatif. Définit le format de fichier que renvoie le build.

Name
format
Type
string
défaut glb
Description
Le format de fichier que renvoie le build.
Valeurs disponibles :
- glb : un fichier model.glb, dans model_urls.glb
- obj : un fichier zip avec model.obj, model.mtl, et texture.png, dans model_urls.obj
- zip : un fichier zip avec tous les fichiers générés par Meshy, dans model_urls.bundle_zip

Retours

Le champ result contient l'ID de la nouvelle tâche de build. Récupérez la tâche ou diffusez-la en flux continu jusqu'à ce que status soit SUCCEEDED. Téléchargez ensuite le fichier depuis l'unique entrée de model_urls.

Modes d'échec

Name
400 - Bad Request
Description
La requête ne peut pas s'exécuter. Par exemple :
- input_task_id est manquant ou n'est pas un ID de tâche valide.
- Le statut de la tâche de prototype n'est pas SUCCEEDED. S'il est encore en cours d'exécution, attendez et réessayez. S'il a échoué ou a été annulé, créez une nouvelle tâche de prototype.
- La tâche de prototype a réussi mais n'a pas d'image. Créez une nouvelle tâche de prototype.
- Un champ options est en dehors de sa plage ou n'est pas une valeur disponible.
Le message d'erreur indique quel problème a été trouvé.
Name
401 - Unauthorized
Description
La clé API est manquante ou invalide. Vérifiez l'en-tête Authorization.
Name
402 - Payment Required
Description
L'un des cas suivants s'applique :
- Le compte n'a pas assez de crédits.
- La clé API, l'espace de travail ou le membre a atteint sa limite de crédits.
- Le compte est sur le plan gratuit.
Vérifiez vos crédits et votre plan, puis réessayez.
Name
404 - Not Found
Description
input_task_id ne correspond à aucune tâche de prototype Keychain créée par votre compte avec l'API. Un prototype créé dans l'application web renvoie également 404. Envoyez l'ID result provenant d'une réponse de création de prototype.
Name
429 - Too Many Requests
Description
L'une de ces limites a été atteinte :
- Vous avez envoyé plus de requêtes que votre limite de débit ne le permet. Attendez quelques secondes, puis réessayez. Voir Limites de débit.
- Trop de vos tâches sont en file d'attente ou en cours d'exécution. Attendez que certaines se terminent, puis réessayez.
- Sur un plan illimité sans crédits restants, vous avez atteint le nombre de tâches pouvant s'exécuter sans crédits. Attendez qu'une tâche se termine, ou ajoutez des crédits.

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Récupérer une tâche Keychain

Renvoie une tâche de prototype ou de build. Le chemin doit correspondre à l'étape de la tâche. Une tâche de build demandée via /prototype/:id renvoie 404, de même qu'une tâche de prototype demandée via /build/:id.

Pour les champs, consultez L'objet tâche de prototype Keychain et L'objet tâche de build Keychain.

Request

GET

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Paramètres

Name
id
Type
path
Description
L'ID de la tâche provenant de la réponse de création.

Retour

L'objet tâche de prototype ou l'objet tâche de build, selon l'étape indiquée dans le chemin.

Modes d'échec

Name
400 - Bad Request
Description
id n'est pas un ID de tâche valide. Envoyez l'ID result provenant de la réponse de création.
Name
403 - Forbidden
Description
Votre équipe a activé le filtrage IP, et Meshy a signalé l'image de la tâche de prototype pour propriété intellectuelle tierce. Les tâches de build et les équipes sous le plan Enterprise ne reçoivent pas cette erreur. Créez une tâche de prototype à partir d'une image dont vous détenez les droits d'utilisation.
Name
404 - Not Found
Description
Aucune tâche Keychain avec cet ID n'appartient à votre compte, ou l'étape de la tâche ne correspond pas au chemin. Vérifiez l'ID et utilisez /prototype ou /build pour faire correspondre la tâche.
Name
500 - Internal Server Error
Description
Meshy n'a pas pu exécuter la vérification de propriété intellectuelle. Réessayez la requête.

DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Supprimer une tâche Keychain

Annule une tâche Keychain. Annuler une tâche PENDING rembourse ses crédits. Une tâche IN_PROGRESS est annulée sans remboursement, car un worker l'a déjà prise en charge. Une tâche ayant un statut final (SUCCEEDED, FAILED ou CANCELED) ne peut pas être annulée.

Le chemin doit correspondre à l'étape de la tâche. Par exemple, un DELETE sur /prototype/:id avec l'ID d'une tâche de build renvoie 404.

Request

DELETE

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Paramètres de chemin

Name
id
Type
path
Description
L'ID de la tâche à annuler.

Retours

204 No Content avec un corps vide.

Modes d'échec

Name
400 - Bad Request
Description
L'un des cas suivants s'applique :
- id n'est pas un ID de tâche valide. Envoyez l'ID result de la réponse de création.
- La tâche a déjà un statut final (SUCCEEDED, FAILED ou CANCELED), elle ne peut donc pas être annulée.
Name
404 - Not Found
Description
Aucune tâche Keychain avec cet ID n'appartient à votre compte, ou l'étape de la tâche ne correspond pas au chemin. Vérifiez l'ID, et utilisez /prototype ou /build pour correspondre à la tâche.

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

Diffuser un task Keychain en flux

Diffuse les mises à jour d'un task Keychain sous forme d'événements envoyés par le serveur (SSE). Le chemin doit correspondre à l'étape du task. Si ce n'est pas le cas, par exemple l'ID d'un task de build sur /prototype/:id/stream, le flux envoie un événement error unique avec status_code: 404 puis se ferme.

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Paramètres

Name
id
Type
path
Description
L'ID du task issu de la réponse de création.

Retours

Un flux d'objets task prototype ou build. Chaque événement contient l'objet task complet, tel que renvoyé par Récupérer un task Keychain. Tant que le task est PENDING ou IN_PROGRESS, ses champs de sortie restent vides (null, [] ou {}), et finished_at vaut null.

Si le filtrage IP bloque le résultat du task, le flux envoie à la place un seul événement error, avec le status_code qu'une requête get aurait renvoyé.

GET/openapi/creative-lab/keychain/v1/(prototype|build)

Lister les tâches Keychain

Renvoie vos tâches de porte-clés d'un stade donné, une page à la fois. Le chemin sélectionne le stade. /prototype renvoie uniquement les tâches de prototype, et /build renvoie uniquement les tâches de build.

Request

GET

/openapi/creative-lab/keychain/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Paramètres de chemin

Name
stage
Type
path
Requis
Description
Le stade à lister, prototype ou build.

Paramètres de requête

Name
page_num
Type
integer
défaut 1
Description
La page à renvoyer, de 1 à 255. 0 renvoie la première page. Une valeur en dehors de 0 à 255 renvoie 400.
Name
page_size
Type
integer
défaut 10
Description
Nombre de tâches par page, jusqu'à 100. Une valeur de 101 à 255 renvoie 100 tâches, et 0 utilise la valeur par défaut. Une valeur en dehors de 0 à 255 renvoie 400.
Name
sort_by
Type
string
défaut -created_at
Description
L'ordre de tri.
Valeurs disponibles :
- -created_at : du plus récent au plus ancien
- +created_at : du plus ancien au plus récent

Retours

Un tableau d'objets tâche de prototype ou d'objets tâche de build, correspondant au stade indiqué dans le chemin.

L'objet tâche de prototype Keychain

Une tâche de prototype génère une image conceptuelle colorisée à partir d'une photo. Pour transformer l'image en modèle 3D, transmettez l'ID de la tâche au point de terminaison de build en tant que input_task_id.

Propriétés

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
L'ID de la tâche. Ne vous fiez pas à son format.
Name
type
Type
string
Description
Le type de la tâche, toujours creative-lab-keychain-prototype.
Name
name
Type
string
Description
Le name que vous avez envoyé lors de la création de la tâche, ou "" si vous n'en avez pas envoyé.
Name
name_text
Type
string
Description
Le nom que Meshy a ajouté au porte-clés, après suppression des espaces superflus et des caractères de formatage invisibles. Omis lorsque vous n'avez pas envoyé name_text. Pour vérifier que votre client HTTP a correctement encodé le texte, comparez-le avec ce que vous avez envoyé.
Name
status
Type
string
Description
Le statut de la tâche.
Valeurs disponibles :
- PENDING : en attente dans la file
- IN_PROGRESS : génération du résultat en cours
- SUCCEEDED : finale, avec le résultat
- FAILED : finale, avec la raison dans task_error
- CANCELED : finale, sans résultat
Name
progress
Type
integer
Description
Pourcentage du travail effectué, de 0 à 100. Il est à 0 jusqu'au démarrage de la tâche et à 100 lorsqu'elle réussit.
Name
created_at
Type
timestamp
Description
Heure de création de la tâche, en millisecondes Unix.
Name
started_at
Type
timestamp
Description
Heure à laquelle un worker a démarré la tâche, en millisecondes Unix. null jusque-là.
Name
finished_at
Type
timestamp
Description
Heure à laquelle la tâche a atteint un statut final, en millisecondes Unix. null jusque-là.
Name
expires_at
Type
timestamp
Description
Heure d'expiration du résultat de la tâche, en millisecondes Unix. Elle correspond à 3 jours après finished_at, ou à 3 jours après created_at tant que la tâche n'est pas terminée. Pour les comptes Entreprise, qui conservent les résultats de l'API indéfiniment, c'est environ 100 ans plus tard. Voir Conservation des ressources.
Name
preceding_tasks
Type
integer
Description
La position de la tâche dans la file tant qu'elle est PENDING. 1 signifie qu'elle démarre ensuite. 0 une fois que la tâche a quitté la file, et toujours 0 dans les résultats de liste.
Name
task_error
Type
object
Description
La raison de l'échec de la tâche. null sauf si status est FAILED. Voir Erreurs.
Name
consumed_credits
Type
integer
Description
Nombre de crédits facturés pour la tâche, après tout remboursement éventuel. Une requête qui renvoie une erreur n'est pas facturée. Une tâche ayant échoué est à 0, car Meshy la rembourse. L'annulation ne rembourse une tâche que tant qu'elle est PENDING. Si Meshy ne parvient pas à lire le montant facturé, une réponse get ou stream omet ce champ, et une requête de liste renvoie 500. Dans ce cas, réessayez la requête.
Name
image_urls
Type
array of strings
Description
URLs de téléchargement de l'image conceptuelle. Le tableau contient une URL une fois la tâche réussie, et reste vide jusque-là.

L'objet tâche de génération de porte-clés

Une tâche de génération crée le porte-clés 3D à partir d'une tâche de prototype réussie. Elle renvoie un fichier modèle dans le format demandé.

Propriétés

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
L'ID de la tâche. Ne vous fiez pas à son format.
Name
type
Type
string
Description
Le type de tâche, toujours creative-lab-keychain-build.
Name
name
Type
string
Description
Le name que vous avez envoyé lors de la création de la tâche, ou "" si vous n'en avez pas envoyé.
Name
status
Type
string
Description
Le statut de la tâche.
Valeurs disponibles :
- PENDING : en attente dans la file
- IN_PROGRESS : génération du résultat en cours
- SUCCEEDED : terminée, avec le résultat
- FAILED : terminée, avec la raison dans task_error
- CANCELED : terminée, sans résultat
Name
progress
Type
integer
Description
Pourcentage du travail effectué, de 0 à 100. Il est à 0 tant que la tâche n'a pas commencé et à 100 lorsqu'elle réussit.
Name
created_at
Type
timestamp
Description
Heure de création de la tâche, en millisecondes Unix.
Name
started_at
Type
timestamp
Description
Heure à laquelle un worker a démarré la tâche, en millisecondes Unix. null jusqu'à ce moment-là.
Name
finished_at
Type
timestamp
Description
Heure à laquelle la tâche a atteint un statut final, en millisecondes Unix. null jusqu'à ce moment-là.
Name
expires_at
Type
timestamp
Description
Heure d'expiration du résultat de la tâche, en millisecondes Unix. C'est 3 jours après finished_at, ou 3 jours après created_at tant que la tâche n'est pas terminée. Pour les comptes Entreprise, qui conservent les résultats de l'API indéfiniment, c'est environ 100 ans plus tard. Voir Conservation des ressources.
Name
preceding_tasks
Type
integer
Description
La position de la tâche dans la file tant qu'elle est PENDING. 1 signifie qu'elle démarre ensuite. 0 une fois la tâche sortie de la file, et toujours 0 dans les résultats de liste.
Name
task_error
Type
object
Description
La raison de l'échec de la tâche. null sauf si status est FAILED. Voir Erreurs.
Name
consumed_credits
Type
integer
Description
Nombre de crédits facturés pour la tâche, après remboursement éventuel. Une requête qui renvoie une erreur n'est pas facturée. Une tâche échouée est à 0, car Meshy la rembourse. L'annulation ne rembourse une tâche que tant qu'elle est PENDING. Si Meshy ne parvient pas à lire la charge, une réponse de type get ou stream omet le champ, et une requête de liste renvoie 500. Dans ce cas, réessayez la requête.
Name
model_urls
Type
object
Description
URL de téléchargement du fichier modèle, avec une entrée pour le output.format demandé. {} tant que la tâche n'a pas réussi.
- Name
  glb
  Type
  string
  Description
  URL de téléchargement du fichier GLB. Présent lorsque output.format est glb.
- Name
  obj
  Type
  string
  Description
  URL de téléchargement d'un fichier zip contenant model.obj, model.mtl et texture.png. Présent lorsque output.format est obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL de téléchargement d'un fichier zip contenant tous les fichiers générés par Meshy. Présent lorsque output.format est zip.