Skip to main content
POST

Autorisations

Authorization
string
header
requis

##Toutes les API nécessitent une authentification Bearer Token##

Obtenir une clé API :

Visitez la Page de gestion des clés API pour obtenir votre clé API

Ajouter à l'en-tête de requête :

Corps

application/json
model
enum<string>
requis

Nom du modèle de génération d'images. La génération texte vers image et l'édition d'image partagent ce nom de modèle ; le mode bascule automatiquement selon que image_urls est fourni ou non

Options disponibles:
grok-imagine-image-2.0
Exemple:

"grok-imagine-image-2.0"

prompt
string
requis

Prompt décrivant l'image souhaitée, ou la manière d'éditer les images de référence fournies

Syntaxe de référence multi-images :

  • Lorsque plusieurs images de référence sont fournies, utilisez <IMAGE_0>, <IMAGE_1>, <IMAGE_2> dans le prompt pour désigner respectivement la 1re, la 2e et la 3e image de référence
  • Les index commencent à 0 et correspondent un à un à l'ordre du tableau image_urls
  • Exemple : Place le personnage de <IMAGE_0> dans la scène de <IMAGE_1>
Exemple:

"Rue de Tokyo la nuit dans un style cyberpunk, néons se reflétant sur la chaussée mouillée"

image_urls
string<uri>[]

Liste d'URL d'images de référence pour les fonctions image vers image et édition d'image

Remarque :

  • Nombre d'images d'entrée par requête : 0~3 (sans ce paramètre = texte vers image, 1~3 = édition d'image)
  • Seules les URL d'images http / https accessibles publiquement sont prises en charge ; base64 et data URL ne le sont pas
  • Formats de fichiers pris en charge : .jpeg, .jpg, .png, .webp
  • Les URL d'images doivent être directement accessibles par le serveur, ou l'URL de l'image doit déclencher un téléchargement direct lors de l'accès (généralement ces URL se terminent par des extensions de fichiers image, telles que .png, .jpg)
  • En édition d'image, les images de référence entraînent un coût supplémentaire, compté une seule fois par requête et non multiplié par n
Maximum array length: 3
Exemple:
size
enum<string>
défaut:auto

Rapport largeur/hauteur de l'image générée, auto par défaut

Rapports pris en charge (13) :

Remarque :

  • auto : le modèle choisit lui-même le rapport ; omettre ce paramètre équivaut à auto (la sortie est généralement en portrait)
  • Toute valeur absente du tableau ci-dessus n'est pas prise en charge
Options disponibles:
1:1,
4:3,
3:4,
3:2,
2:3,
16:9,
9:16,
2:1,
1:2,
19.5:9,
9:19.5,
20:9,
9:20,
auto
Exemple:

"16:9"

resolution
enum<string>
défaut:1K

Niveau de pixels de l'image de sortie, 1K par défaut ; prend en charge les niveaux 1K et 2K

Remarque :

  • Ce modèle ne prend pas en charge 4K
  • Les valeurs sont insensibles à la casse
Options disponibles:
1K,
2K
Exemple:

"1K"

quality
enum<string>
défaut:medium

Niveau de qualité de génération, contrôle la profondeur de réflexion du modèle, medium par défaut

Remarque :

  • Ce modèle ne prend en charge que les niveaux low / medium ; toute autre valeur telle que high n'est pas prise en charge
  • quality (niveau de qualité) et resolution (niveau de pixels) sont indépendants et librement combinables
  • Les valeurs sont insensibles à la casse
Options disponibles:
low,
medium
Exemple:

"medium"

n
integer
défaut:1

Nombre d'images à générer, plage 1~10, 1 par défaut

Remarque :

  • Chaque image est facturée séparément, le coût augmente linéairement avec n
  • Le coût supplémentaire des images de référence est compté une seule fois par requête et n'est pas multiplié par n
  • Une fois la tâche terminée, result_urls renvoie n liens d'images indépendants
Plage requise: 1 <= x <= 10
Exemple:

1

callback_url
string<uri>

Adresse de rappel HTTPS après l'achèvement de la tâche

Moment du rappel :

  • Déclenché lorsque la tâche est terminée, échouée ou annulée
  • Envoyé après confirmation de la facturation

Restrictions de sécurité :

  • Seul le protocole HTTPS est pris en charge
  • Les rappels vers les adresses IP internes sont interdits (127.0.0.1, 10.x.x.x, 172.16-31.x.x, 192.168.x.x, etc.)
  • La longueur de l'URL ne doit pas dépasser 2048 caractères

Mécanisme de rappel :

  • Délai d'expiration : 10 secondes
  • Maximum 3 tentatives en cas d'échec (tentatives après 1 seconde/2 secondes/4 secondes)
  • Le format du corps de réponse du rappel est cohérent avec le format de réponse de l'API de requête de tâche
  • Un code de statut 2xx renvoyé par l'adresse de rappel est considéré comme un succès, les autres codes de statut déclenchent une nouvelle tentative
Exemple:

"https://your-domain.com/webhooks/image-task-completed"

Réponse

Tâche d'image créée avec succès

created
integer

Horodatage de création de la tâche

Exemple:

1757156493

id
string

ID de tâche

Exemple:

"task-unified-1757156493-imcg5zqt"

model
string

Nom du modèle réellement utilisé

Exemple:

"grok-imagine-image-2.0"

object
enum<string>

Type spécifique de tâche

Options disponibles:
image.generation.task
progress
integer

Pourcentage de progression de la tâche (0-100)

Plage requise: 0 <= x <= 100
Exemple:

0

status
enum<string>

Statut de la tâche

Options disponibles:
pending,
processing,
completed,
failed
Exemple:

"pending"

task_info
object

Informations sur la tâche asynchrone

type
enum<string>

Type de sortie de la tâche

Options disponibles:
text,
image,
audio,
video
Exemple:

"image"

usage
object

Informations d'utilisation et de facturation