Skip to main content
POST
Usa esta ruta para editar una o más imágenes con modelos de imagen Grok. El cuerpo de la solicitud usa application/json.

​
Proporcionar imágenes de entrada

  • Envía exactamente uno de image o images.
  • Usa image para una imagen de origen.
  • Usa images para dos o tres imágenes de origen.
  • En cada objeto de imagen, usa url para una URL pública o un URI de datos. image_url es un alias de compatibilidad para url.
  • Usa aspect_ratio para controlar el formato de salida de las ediciones de varias imágenes.
Elige un ID de modelo de imagen de Grok en la página de modelos. Los ejemplos de la API usan grok-imagine-image-quality.
Envía solicitudes de edición de imágenes de Grok como JSON. Los datos de formulario multipartes no representan esta estructura de solicitud.
El método images.edit() del SDK de OpenAI envía datos de formulario multipartes. Usa una solicitud HTTP directa para las ediciones de imágenes JSON de Grok. Para obtener detalles sobre los parámetros del proveedor, consulta la guía de edición de imágenes de xAI.

Autorizaciones

​
Authorization
string
header
requerido

Use your CometAPI API key as the bearer value.

Cuerpo

application/json
​
model
enum<string>
requerido

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

Opciones disponibles:
grok-imagine-image,
grok-imagine-image-quality
Ejemplo:

"grok-imagine-image-quality"

​
prompt
string
requerido

A text instruction that describes the requested edit.

Minimum string length: 1
Ejemplo:

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

​
image
object
requerido

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
predeterminado:1

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

Rango requerido: 1 <= x <= 10
​
aspect_ratio
enum<string>

The output shape for a multi-image edit.

Opciones 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
Ejemplo:

"16:9"

​
resolution
enum<string>

The requested output resolution.

Opciones disponibles:
1k,
2k
Ejemplo:

"1k"

​
response_format
enum<string>
predeterminado:url

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

Opciones disponibles:
url,
b64_json

Respuesta

200 - application/json

The edited image results.

​
data
object[]
requerido

The edited images.

Minimum array length: 1
​
usage
object
requerido

Usage details for the request.