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 не відповідають цій структурі запиту.
Метод images.edit() SDK OpenAI надсилає дані форми multipart. Для редагування зображень 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.