Skip to main content
POST
Utilisez cette route pour modifier une ou plusieurs images avec les modèles d’image Grok. Le corps de la requête utilise application/json.

​
Fournir des images en entrée

  • Envoyez exactement l’un de image ou images.
  • Utilisez image pour une image source.
  • Utilisez images pour deux ou trois images sources.
  • Dans chaque objet image, utilisez url pour une URL publique ou un URI de données. image_url est un alias de compatibilité pour url.
  • Utilisez aspect_ratio pour contrôler la forme de sortie des modifications multi-images.
Choisissez un ID de modèle d’image Grok sur la page Modèles. Les exemples d’API utilisent grok-imagine-image-quality.
Envoyez les requêtes de modification d’images Grok au format JSON. Les données de formulaire multipart ne représentent pas cette structure de requête.
La méthode images.edit() du SDK OpenAI envoie des données de formulaire multipart. Utilisez une requête HTTP directe pour les modifications d’images Grok en JSON. Pour connaître les détails des paramètres du fournisseur, consultez le guide d’édition d’images xAI.

Autorisations

​
Authorization
string
header
requis

Use your CometAPI API key as the bearer value.

Corps

application/json
​
model
enum<string>
requis

The Grok image model ID. See the Models page for available model IDs.

Options disponibles:
grok-imagine-image,
grok-imagine-image-quality
Exemple:

"grok-imagine-image-quality"

​
prompt
string
requis

A text instruction that describes the requested edit.

Minimum string length: 1
Exemple:

"Replace the daytime sky with a soft sunset and preserve the building"

​
image
object
requis

One source image. Use this field instead of images.

​
images
object[]

Two or three source images. Use this field instead of image.

Required array length: 2 - 3 elements

A source image represented by url or the compatibility alias image_url.

​
n
integer
défaut:1

The number of edited images to generate. Use an integer from 1 through 10.

Plage requise: 1 <= x <= 10
​
aspect_ratio
enum<string>

The output shape for a multi-image edit.

Options disponibles:
1:1,
3:4,
4:3,
16:9,
2:3,
3:2,
9:19.5,
19.5:9,
9:20,
20:9,
1:2
Exemple:

"16:9"

​
resolution
enum<string>

The requested output resolution.

Options disponibles:
1k,
2k
Exemple:

"1k"

​
response_format
enum<string>
défaut:url

The image representation in each response item. Use url for a temporary download URL or b64_json for Base64-encoded image bytes.

Options disponibles:
url,
b64_json

Réponse

200 - application/json

The edited image results.

​
data
object[]
requis

The edited images.

Minimum array length: 1
​
usage
object
requis

Usage details for the request.