Skip to main content
POST
Використовуйте цей маршрут, щоб створювати зображення з тексту за допомогою моделей зображень Grok. Тіло запиту використовує application/json. Запит підтримує model, prompt, n, aspect_ratio, resolution і response_format.

​
Виберіть модель

Виберіть ID моделі зображень Grok на сторінці Моделі. У прикладах API використовується grok-imagine-image-quality.

​
Налаштування виводу

  • Використовуйте aspect_ratio, щоб вибрати формат виводу, або auto, щоб дозволити моделі вибрати формат.
  • Використовуйте resolution, щоб запросити вивід 1k або 2k.
  • Використовуйте n, щоб запросити до 10 зображень.
  • Використовуйте response_format, щоб повертати тимчасові URL або дані зображень, закодовані Base64.
Докладніше про параметри провайдера див. у посібнику xAI з генерації зображень.
Завантажте результати за URL після завершення запиту. URL згенерованих зображень можуть втратити чинність.

Авторизації

​
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 description of the image to generate.

Minimum string length: 1
Приклад:

"A glass observatory above a quiet alpine lake at sunrise"

​
n
integer
за замовчуванням:1

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

Необхідний діапазон: 1 <= x <= 10
​
aspect_ratio
enum<string>

The output shape. Use auto to let the model select the aspect ratio.

Доступні опції:
1:1,
3:4,
4:3,
9:16,
16:9,
2:3,
3:2,
9:19.5,
19.5:9,
9:20,
20:9,
1:2,
2:1,
auto
Приклад:

"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 generated image results.

​
data
object[]
обов'язково

The generated images.

Minimum array length: 1
​
usage
object
обов'язково

Usage details for the request.