API Texte en image

L’API Texte en image est une fonctionnalité qui vous permet d’intégrer les capacités de génération d’images par IA de Meshy dans votre propre application. Générez des images de haute qualité à partir de prompts textuels grâce à nos puissants modèles d’IA.

POST/openapi/v1/text-to-image

Créer une tâche Texte en image

Ce point de terminaison vous permet de créer une nouvelle tâche Texte en image. Consultez L’objet de tâche Texte en image pour voir quelles propriétés sont incluses avec l’objet de tâche Texte en image.

Paramètres

Name
ai_model
Type
string
Requis
Description
ID du modèle à utiliser pour la génération d’images.
Valeurs disponibles :
- nano-banana: Modèle standard (3 crédits par image)
- nano-banana-2: Modèle équilibré avec des capacités plus fortes que le modèle standard (6 crédits par image)
- nano-banana-pro: Modèle pro avec une qualité améliorée (9 crédits par image)
- gpt-image-2: OpenAI GPT Image 2, un modèle d’image haute fidélité avec une prise en charge restreinte des rapports d’aspect (9 crédits par image)
Name
prompt
Type
string
Requis
Description
Une description textuelle de l’image que vous souhaitez générer. Soyez descriptif pour obtenir les meilleurs résultats.
Name
generate_multi_view
Type
boolean
défaut false
Description
Lorsqu’il est défini sur true, génère une image multi-vue montrant le sujet sous plusieurs angles.
Lorsque generate_multi_view est true, le paramètre aspect_ratio ne peut pas être défini.
Name
pose_mode
Type
string
Description
Spécifiez le mode de pose pour la génération de personnages. Lorsqu’il est omis, l’image est générée sans aucun préréglage de pose.
Valeurs disponibles : a-pose, t-pose
Name
aspect_ratio
Type
string
défaut 1:1
Description
Spécifiez le rapport d’aspect de l’image générée. Les valeurs autorisées dépendent du ai_model sélectionné :
- nano-banana, nano-banana-2, nano-banana-pro: 1:1, 16:9, 9:16, 4:3, 3:4
- gpt-image-2: 1:1, 3:2, 2:3 uniquement
Valeurs disponibles :
- 1:1: Format carré
- 16:9: Paysage grand écran (non pris en charge par gpt-image-2)
- 9:16: Portrait grand écran (non pris en charge par gpt-image-2)
- 4:3: Paysage standard (non pris en charge par gpt-image-2)
- 3:4: Portrait standard (non pris en charge par gpt-image-2)
- 3:2: Paysage (pris en charge uniquement par gpt-image-2)
- 2:3: Portrait (pris en charge uniquement par gpt-image-2)

Retours

La propriété result de la réponse contient l’id de tâche de la tâche Texte en image nouvellement créée.

Modes d’échec

Name
400 - Bad Request
Description
La requête était inacceptable. Causes courantes :
- Paramètre manquant : Un paramètre requis (p. ex., ai_model, prompt) est manquant.
- Paramètre invalide : ai_model ou aspect_ratio ne fait pas partie des valeurs autorisées.
- Conflit : generate_multi_view et aspect_ratio ne peuvent pas être utilisés simultanément.
Name
401 - Unauthorized
Description
L’authentification a échoué. Veuillez vérifier votre clé API.
Name
402 - Payment Required
Description
Crédits insuffisants pour effectuer cette tâche.
Name
429 - Too Many Requests
Description
Vous avez dépassé votre limite de débit.

Request

POST

/openapi/v1/text-to-image

# Generate an image from a text prompt
curl https://api.meshy.ai/openapi/v1/text-to-image \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "aspect_ratio": "16:9"
  }'

Response

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

GET/openapi/v1/text-to-image/:id

Récupérer une tâche Texte en image

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

Paramètres

Name
id
Type
path
Description
Identifiant unique de la tâche Texte en image à récupérer.

Retourne

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

Request

GET

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

DELETE/openapi/v1/text-to-image/:id

Supprimer une tâche Texte en image

Ce point de terminaison supprime définitivement une tâche Texte en image, y compris toutes les images et données associées. Cette action est irréversible.

Paramètres de chemin

Name
id
Type
path
Description
L’ID de la tâche Texte en image à supprimer.

Renvoie

Renvoie 200 OK en cas de succès.

Request

DELETE

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/text-to-image

Lister les tâches Texte en image

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

Paramètres

Name
page_num
Type
integer
Description
Numéro de page pour la pagination. Commence à 1 et vaut 1 par défaut.
Name
page_size
Type
integer
Description
Limite de taille de page. Par défaut, 10 éléments. Le maximum autorisé est de 50 éléments.
Name
sort_by
Type
string
Description
Champ selon lequel trier. Valeurs disponibles :
- +created_at: Trier par heure de création par ordre croissant.
- -created_at: Trier par heure de création par ordre décroissant.

Retours

Renvoie une liste paginée des objets de tâche Texte en image.

Request

GET

/openapi/v1/text-to-image

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-image",
    "ai_model": "nano-banana",
    "prompt": "A majestic dragon soaring through clouds at sunset",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1692771650657,
    "started_at": 1692771667037,
    "finished_at": 1692771669037,
    "expires_at": 1692771679037,
    "image_urls": [
      "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
    ]
  }
]

GET/openapi/v1/text-to-image/:id/stream

Diffuser une tâche Texte en image

Ce point de terminaison diffuse des mises à jour en temps réel pour une tâche Texte en image à l’aide de Server-Sent Events (SSE).

Paramètres

Name
id
Type
path
Description
Identifiant unique de la tâche Texte en image à diffuser.

Retours

Retourne un flux de The Text to Image Task Objects 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.

Request

GET

/openapi/v1/text-to-image/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/text-to-image/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",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ]
}

L’objet de tâche Texte en image

L’objet de tâche Texte en image est une unité de travail que Meshy suit afin de générer une image à partir d’une entrée prompt textuel. 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 k-sortable pour les identifiants de tâche comme détail d’implémentation, vous ne devez faire aucune hypothèse sur le format de l’id.
Name
type
Type
string
Description
Le type de tâche de génération d’image. Pour les tâches Texte en image, ce sera toujours text-to-image.
Name
ai_model
Type
string
Description
Le modèle d’IA utilisé pour cette tâche. Les valeurs possibles sont nano-banana, nano-banana-2, nano-banana-pro ou gpt-image-2.
Name
prompt
Type
string
Description
Le prompt textuel qui a été utilisé pour générer l’image.
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’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 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 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’a pas encore démarré, 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’a de sens que si le statut de la tâche est PENDING.
Name
image_urls
Type
array
Description
Un tableau d’URL téléchargeables vers les images générées. Lorsque generate_multi_view est activé, ce tableau contient trois URL d’image représentant différents angles de vue. Sinon, il contient une seule URL d’image.
Name
task_error
Type
object
Description
Détails de l’erreur pour les tâches échouées. Consultez Erreurs pour la référence complète de l’objet task_error.
Name
consumed_credits
Type
integer
Description
Le nombre de crédits consommés par cette tâche. Présent lorsque le statut de la tâche est PENDING, IN_PROGRESS ou SUCCEEDED. Renvoie 0 pour les tâches FAILED (les crédits sont remboursés en cas d’échec).

Example Text to Image Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-image",
  "ai_model": "nano-banana",
  "prompt": "A majestic dragon soaring through clouds at sunset",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "expires_at": 1692771679037,
  "preceding_tasks": 0,
  "image_urls": [
    "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/image.png?Expires=***"
  ],
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3
}