API Texte en 3D

L'API Texte en 3D est une fonctionnalité qui vous permet d'intégrer les capacités Texte en 3D de Meshy dans votre propre application. Dans cette section, vous trouverez toutes les informations dont vous avez besoin pour démarrer avec cette API.

Texte en 3D utilise un flux de travail en deux étapes. Tout d'abord, créez une tâche de prévisualisation (mode: "preview") pour générer un maillage 3D sans texture, afin que vous puissiez évaluer la forme. Ensuite, transmettez l'ID de tâche de la prévisualisation terminée à une tâche refine (mode: "refine") pour appliquer une texture au maillage. Les deux étapes partagent le même point de terminaison.


POST/openapi/v2/text-to-3d

Create a Text to 3D Preview Task

Ce point de terminaison crée une tâche de preview Texte en 3D, qui génère un maillage 3D non texturé (géométrie uniquement) à partir d'un prompt textuel. C'est la première étape du workflow en deux temps. Une fois la preview réussie, utilisez l'ID de tâche retourné pour créer une tâche refine afin d'appliquer les textures. Consultez L'objet de tâche Texte en 3D pour le schéma de réponse complet.

Paramètres

  • Name
    mode
    Type
    string
    Requis
    Description

    Ce champ doit être défini sur "preview" lors de la création d'une tâche de preview.

  • Name
    prompt
    Type
    string
    Requis
    Description

    Décrivez le type d'objet que représente le modèle 3D. Maximum 800 caractères.

  • Name
    model_type
    Type
    string
    défaut standard
    Description

    Spécifie le type de génération de maillage 3D.

    Valeurs disponibles :

    • standard : génération de maillage 3D standard haute-définition.
    • smart-topology : choisissez le modèle Smart Topology avec ai_model (meshy-t2).
    • lowpoly (obsolète) : génère un maillage low-poly optimisé pour des polygones plus propres. Nous recommandons d'utiliser smart-topology à la place.
  • Name
    ai_model
    Type
    string
    défaut latest
    Description

    ID du modèle à utiliser. Les valeurs disponibles dépendent de model_type.

    Génération standard (model_type: standard) :

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (obsolète) : utilisez meshy-7.1 à la place.

    Génération Smart Topology (model_type: smart-topology) :

    • meshy-t2 (par défaut) : le modèle Smart Topology — topology plus propre, parties nativement séparées, sortie en triangles, et un nombre de faces que vous pouvez définir avec target_polycount.
  • Name
    geometry_resolution
    Type
    string
    défaut standard
    Description

    Passe de génération de géométrie. 2k exécute la passe Ultra à 2048³ ; 4k l'exécute à 4096³ pour le détail de surface le plus fin.

    Valeurs disponibles : standard, 2k, 4k

  • 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_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 le modèle de la plus haute qualité, 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 quads.
    • triangle : génère un maillage triangulaire décimé.
  • 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 bas.
  • Name
    target_polycount
    Type
    integer
    Description

    Nombre cible de polygones (faces) dans la sortie. Le nombre réel peut s'écarter de la cible selon la géométrie.

    target_polycount s'applique dans deux cas indépendants :

    • Remaillage — avec should_remesh: true sur un modèle standard. Le maillage est remaillé (décimé) pour atteindre approximativement ce nombre. Plage de 100 à 300 000, par défaut 30 000. Si decimation_mode est défini, il est prioritaire et target_polycount est ignoré.
    • Smart Topology — avec model_type: smart-topology et ai_model: meshy-t2. Le modèle est généré directement avec ce nombre de faces ; aucun remaillage n'est exécuté et should_remesh n'est pas requis. Plage de 100 à 15 000, par défaut 4 000.
  • 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.
    • on : force la symétrie pendant la génération.
  • Name
    pose_mode
    Type
    string
    défaut ""
    Description

    Spécifie le pose_mode pour le modèle généré.

    Valeurs disponibles :

    • a-pose : génère le modèle en pose A.
    • t-pose : génère le modèle en pose T.
    • "" (chaîne vide) : aucune pose spécifique appliquée.
  • Name
    is_a_t_pose
    Type
    boolean
    obsolète
    défaut false
    Description

    Utilisez pose_mode à la place. Indique s'il faut générer le modèle en pose A/T.

  • Name
    art_style
    Type
    string
    obsolète
    défaut realistic
    Description

    Non prise en charge par Meshy-6. Les requêtes utilisant Meshy-6 ignoreront art_style, et certaines combinaisons peuvent provoquer des erreurs. Valeurs disponibles : realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    défaut false
    Description

    Lorsque défini sur true, le contenu d'entrée sera automatiquement analysé pour détecter tout contenu potentiellement nuisible. Si un contenu nuisible est détecté, la tâche ne passera pas à la génération.

    Le texte de prompt sera analysé.

  • 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 retournés, ce qui peut réduire le temps d'exécution de la tâche. Si omis, tous les formats pris en charge sont inclus.

    Valeurs disponibles : glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    défaut false
    Description

    Lorsque défini sur true, la tâche rend en plus une version à fond transparent (RGBA) de la preview et la retourne dans alpha_thumbnail_url sur la réponse GET. Le champ existant thumbnail_url reste inchangé.

  • Name
    auto_size
    Type
    boolean
    défaut false
    Description

    Lorsque 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.

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.

Retour

La propriété result de la réponse contient l'id de tâche de la nouvelle tâche Texte en 3D créée.

Modes d'échec

  • Name
    400 - Bad Request
    Description

    La requête était inacceptable. Causes courantes :

    • Paramètre manquant : un paramètre requis (par exemple, prompt, mode) est manquant.
    • Paramètre invalide : art_style ne fait pas partie des valeurs autorisées.
    • Prompt trop long : le prompt dépasse la limite de caractères.
    • Modèle non pris en charge pour low poly : ai_model: "meshy-6-lite" ne prend pas en charge model_type: "lowpoly".
    • Modèle non pris en charge pour Ultra : geometry_resolution nécessite meshy-7.1 ou latest.
  • 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/v2/text-to-3d
# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with Ultra 4K geometry, remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

Créer une tâche Refine Texte en 3D

Ce point de terminaison crée une tâche refine Texte en 3D, qui applique une texture à un maillage preview terminé. Vous devez fournir le preview_task_id d'une tâche preview réussie. Il s'agit de la deuxième étape du flux de travail en deux étapes.

Paramètres

  • Name
    mode
    Type
    string
    Requis
    Description

    Ce champ doit être défini sur "refine" lors de la création d'une tâche refine.

  • Name
    preview_task_id
    Type
    string
    Requis
    Description

    L'identifiant de la tâche preview correspondante.

    Le statut de la tâche preview donnée doit être SUCCEEDED.

  • 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 (aucune carte d'émission n'est produite). 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 suivantes : 2k (2048×2048), 4k (4096×4096) ou 8k (8192×8192). Des résolutions plus élevées capturent davantage de détails de surface. S'applique uniquement au mode refine.

  • 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 est prioritaire.

  • Name
    texture_prompt
    Type
    string
    Description

    Fournissez un prompt textuel supplémentaire 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 : une URI de données 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
    ai_model
    Type
    string
    défaut inherited from the preview task
    Description

    ID du modèle à utiliser pour le refine.

    Valeurs disponibles :

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (obsolète) : utilisez meshy-7.1 à la place.

    Omettez ce paramètre pour hériter du modèle utilisé par la tâche preview, ce qui permet de conserver le même modèle de bout en bout entre un preview et son refine. Passez une valeur explicite pour outrepasser cet héritage.

  • Name
    moderation
    Type
    boolean
    défaut false
    Description

    Lorsque défini sur true, le contenu fourni sera automatiquement analysé afin de détecter tout contenu potentiellement nuisible. Si un contenu nuisible est détecté, la tâche ne passera pas à l'étape de génération.

    Le texte de texture_prompt ainsi que l'image de texture_image_url seront analysés.

  • 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.

  • 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'achèvement de la tâche. Si omis, tous les formats pris en charge sont inclus.

    Valeurs disponibles : glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    défaut false
    Description

    Lorsque défini sur true, la tâche effectue en plus un rendu de la preview avec un fond transparent (RGBA) et le renvoie sous la forme alpha_thumbnail_url dans la réponse GET. Le champ existant thumbnail_url reste inchangé.

  • Name
    auto_size
    Type
    boolean
    défaut false
    Description

    Lorsque 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.

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 la tâche Texte en 3D nouvellement créée.

Modes d'échec

  • Name
    400 - Bad Request
    Description

    La requête était inacceptable. Causes courantes :

    • ID de tâche invalide : le preview_task_id est invalide ou n'existe pas.
    • Tâche non prête : la tâche preview n'a pas encore réussi.
    • Incompatibilité de modèle : le modèle d'IA de la tâche preview est incompatible avec le modèle de refine demandé.
  • 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 preview spécifiée par preview_task_id est introuvable.

  • Name
    429 - Too Many Requests
    Description

    Vous avez dépassé votre limite de débit.

Request

POST
/openapi/v2/text-to-3d
# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

Récupérer une tâche Texte en 3D

Ce point de terminaison vous permet de récupérer une tâche Texte en 3D à partir d'un id de tâche valide. Consultez L'objet tâche Texte en 3D pour voir quelles propriétés sont incluses dans l'objet tâche Texte en 3D.

Ce point de terminaison fonctionne à la fois pour les tâches preview et refine.

Paramètres

  • Name
    id
    Type
    path
    Description

    Identifiant unique de la tâche Texte en 3D à récupérer.

Retours

La réponse contient l'objet tâche Texte en 3D. Consultez la section L'objet tâche Texte en 3D pour plus de détails.

Exemples

ModeModèle exemple
PreviewPreview model
RefineRefined model

Request

GET
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Supprimer une tâche Texte en 3D

Ce point de terminaison supprime définitivement une tâche Texte 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 Texte en 3D à supprimer.

Statut de la tâche

Une tâche 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 d'une tâche déjà démarrée par le worker 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 terminal (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.

Request

DELETE
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 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."
}

GET/openapi/v2/text-to-3d

Lister les tâches Texte en 3D

Ce point de terminaison vous permet de récupérer une liste de tâches Texte en 3D.

Paramètres

  • 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
    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.

Retours

Retourne une liste paginée des objets de tâche Texte en 3D.

Request

GET
/openapi/v2/text-to-3d
curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

Diffuser une tâche Texte en 3D en continu

Ce point de terminaison diffuse en continu les mises à jour en temps réel d'une tâche Texte en 3D à l'aide des Server-Sent Events (SSE).

Paramètres

  • Name
    id
    Type
    path
    Description

    Identifiant unique de la tâche Texte en 3D à diffuser en continu.

Retours

Renvoie un flux d'objets de tâche Texte en 3D sous forme de Server-Sent Events.

Pour les tâches PENDING ou IN_PROGRESS, le flux de réponse n'inclura que les champs nécessaires progress et status.

Request

GET
/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "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: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"texture_urls": [
  {
    "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
    "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
    "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
    "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
    "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
  }
],
"preceding_tasks": 0,
"task_error": {

  "message": ""

},

"consumed_credits": 20
}

L'objet Tâche Texte en 3D

L'objet Tâche Texte en 3D est une unité de travail que Meshy suit pour générer un modèle 3D à partir d'une entrée textuelle. Il existe deux étapes de l'API Texte en 3D, preview et refine. L'étape preview permet de générer un modèle 3D composé uniquement d'un maillage, et l'étape refine permet de générer un modèle 3D texturé à partir du résultat de l'étape preview.

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 triable par k 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 Texte en 3D. Les valeurs possibles sont text-to-3d-preview pour les tâches de l'étape preview et text-to-3d-refine pour les tâches de l'étape refine.

  • 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
      usdz
      Type
      string
      Description

      URL téléchargeable vers le fichier USDZ.

    • Name
      obj
      Type
      string
      Description

      URL téléchargeable vers le fichier OBJ.

    • Name
      mtl
      Type
      string
      Description

      URL téléchargeable vers le fichier MTL.

    • 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
    prompt
    Type
    string
    Description

    Il s'agit du prompt non modifié qui a été utilisé pour créer la tâche.

  • Name
    negative_prompt
    Type
    string
    obsolète
    Description

    Conservé pour la compatibilité ascendante. Ce champ n'a aucun impact fonctionnel sur les modèles générés.

  • Name
    art_style
    Type
    string
    obsolète
    Description

    Le art_style non modifié qui a été utilisé pour créer la tâche preview. Non prise en charge par Meshy-6.

  • Name
    texture_richness
    Type
    string
    obsolète
    Description

    Conservé pour la compatibilité ascendante. Ce champ n'a aucun impact fonctionnel sur les modèles générés.

  • Name
    texture_prompt
    Type
    string
    Description

    Prompt textuel supplémentaire fourni pour guider le processus de texturation pendant l'étape refine.

  • Name
    ultra_mode
    Type
    boolean
    obsolète
    Description

    Obsolète ; utilisez plutôt geometry_resolution.

  • Name
    geometry_resolution
    Type
    string
    Description

    Le niveau Ultra sur lequel la tâche preview a été exécutée (2k ou 4k) ; omis pour standard.

  • Name
    texture_image_url
    Type
    string
    Description

    URL téléchargeable vers l'image de texture utilisée pour guider le processus de texturation.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL téléchargeable vers l'image miniature du fichier de modèle.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    URL téléchargeable vers une version à fond transparent (RGBA) de thumbnail_url. Présent 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
    video_url
    Type
    string
    obsolète
    Description

    URL téléchargeable vers la vidéo d'aperçu. Sera supprimé dans une future version.

  • 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.

  • Name
    created_at
    Type
    timestamp
    Description

    Horodatage de la création 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, celui-ci 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.

    • Name
      normal
      Type
      string
      Description

      URL téléchargeable vers l'image de la normal map.

    • Name
      roughness
      Type
      string
      Description

      URL téléchargeable vers l'image de la carte de rugosité.

    • Name
      emission
      Type
      string
      Description

      URL téléchargeable vers l'image de la carte d'émission.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Le nombre de tâches précédentes.

  • Name
    task_error
    Type
    object
    Description

    Détails de l'erreur pour les tâches ayant échoué. 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).

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}