Skip to main content
POST
Используйте этот маршрут для редактирования одного или нескольких изображений с помощью моделей изображений Grok. В теле запроса используется application/json.

Передайте входные изображения

  • Отправьте ровно один из image или images.
  • Используйте image для одного исходного изображения.
  • Используйте images для двух или трёх исходных изображений.
  • В каждом объекте изображения используйте url для общедоступного URL или URI данных. image_url — псевдоним для совместимости с url.
  • Используйте aspect_ratio для управления формой выходного изображения при редактировании нескольких изображений.
Выберите ID модели изображений Grok на странице моделей. В примерах API используется grok-imagine-image-quality.
Отправляйте запросы на редактирование изображений Grok в формате JSON. Данные multipart/form-data не соответствуют формату этого запроса.
Метод images.edit() OpenAI SDK отправляет данные multipart/form-data. Для редактирования изображений Grok в формате JSON используйте прямой HTTP-запрос. Подробнее о параметрах провайдера см. в руководстве xAI по редактированию изображений.

Авторизации

Authorization
string
header
обязательно

Use your CometAPI API key as the bearer value.

Тело

application/json
model
enum<string>
обязательно

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

Доступные опции:
grok-imagine-image,
grok-imagine-image-quality
Пример:

"grok-imagine-image-quality"

prompt
string
обязательно

A text instruction that describes the requested edit.

Minimum string length: 1
Пример:

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

image
object
обязательно

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
по умолчанию:1

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

Требуемый диапазон: 1 <= x <= 10
aspect_ratio
enum<string>

The output shape for a multi-image edit.

Доступные опции:
1:1,
3:4,
4:3,
16:9,
2:3,
3:2,
9:19.5,
19.5:9,
9:20,
20:9,
1:2
Пример:

"16:9"

resolution
enum<string>

The requested output resolution.

Доступные опции:
1k,
2k
Пример:

"1k"

response_format
enum<string>
по умолчанию:url

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

Доступные опции:
url,
b64_json

Ответ

200 - application/json

The edited image results.

data
object[]
обязательно

The edited images.

Minimum array length: 1
usage
object
обязательно

Usage details for the request.