Интеграция Grok Imagine API
Используйте Grok Imagine через Rivya Public API v1: ID модели grok-imagine, поддерживаемые входные данные, параметры, правила Files API, кредиты и примеры ответов.
grok-imagine
text, file
Требуется для референсных режимов
4
Изображение
FIXED
5000 символов
Контракт запроса
Передавайте ID модели на верхнем уровне. Управляющие параметры конкретной модели размещайте в params.
| Ключ | Тип | Обязательно | По умолчанию | Описание |
|---|---|---|---|---|
| model | string | Да | grok-imagine | Используйте grok-imagine как ID модели API. |
| prompt | string | Да | - | Максимум 5000 символов для этой модели. |
| params | object | Нет | - | Объект параметров конкретной модели. Допустимые ключи указаны в таблице ниже. |
| client_request_id | string | Нет | - | Необязательный клиентский id для трассировки запросов в вашей системе. |
Параметры модели
| Ключ | Тип | Обязательно | По умолчанию | Диапазон | Варианты | Описание |
|---|---|---|---|---|---|---|
| aspect_ratio | select | Нет | 1:1 | - | 1:1, 2:3, 3:2, 16:9, 9:16 | Соотношение сторон |
| enable_pro | select | Нет | false | - | false, true | Это переключатель качества Grok Imagine только для генерации из текста. Стандартный режим дешевле, а режим качества склоняется к большей детализации; текущий путь редактирования изображений его не использует. |
Политика загрузки
Сначала загрузите референсные файлы, затем поместите возвращенный URL и токен длительности в params.referenceMediaItems.
Референсное изображение: Загрузите до 1 файла изображения для проектов с изображениями.
1
image
Видео- и аудио-референсы должны передавать поле durationToken из /api/v1/files, когда требуется проверка длительности.
| kind | Макс. размер | MIME-типы |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Минимальный запрос
{
"model": "grok-imagine",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"enable_pro": "false"
}
}Запрос с референсным файлом
{
"model": "grok-imagine",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1",
"enable_pro": "false",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Ответ создания
Эндпоинт создания возвращает публичный id задачи. Опрашивайте эндпоинт статуса, пока задача не завершится успехом или ошибкой.
{
"id": "task_grok_imagine_example",
"status": "queued",
"model": "grok-imagine",
"reserved_credits": 4,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Распространенные ошибки
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Некоторым режимам нужны референсные файлы, загруженные через Files API.