Edit images with JSON

The request uses application/json and submits one or more publicly accessible image URLs for editing.

POST/v1/images/edits

Edit one or more reference images by following text instructions. The request must use application/json and provide publicly accessible image URLs through image or images.

This JSON URL request format applies only to models that support Grok image editing.

Use /v1/images/edits, not /v1/edits. For multiple reference images, use images; reference_images is not recommended.

Authorization

bearerAuth

AuthorizationBearer <token>

Use Bearer your-api-key in the Authorization header.

In: header

Request Body

application/json

Grok image-editing request parameters. Provide at least one of image or images.

TypeScript Definitions

Use the request body type in TypeScript.

model*string

Model ID used for image editing. Models that support this request format include grok-imagine-image and grok-imagine-image-pro. Actual availability depends on the model list returned for the current API key and the provider channel.

Length1 <= length

prompt*string

Image-editing instructions. Clearly describe the subject to preserve, the area to change, and the target style.

Length1 <= length

image?|

Conditionally required. Public URL of one input image that both the server and upstream model can access. Provide at least one of image or images.

images?array<>

Conditionally required. List of public URLs for multiple input images. Provide at least one of image or images.

Items1 <= items

size?string

Image dimensions or aspect ratio, such as 1024x1024, 1:1, or 16:9.

n?integer

Number of edited results to generate. When omitted, the request is typically processed as one image.

Range1 <= value

Default1

response_format?string

Response format, determined by the capabilities of the server and upstream model.

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/edits" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "prompt": "Restyle the image as a cyberpunk night scene while preserving the main subject",    "image": "https://example.com/input.png",    "size": "1024x1024",    "n": 1  }'

{
  "created": 1710000000,
  "data": [
    {
      "url": "https://example.com/result.png"
    }
  ]
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`