Документация

Grok Imagine: имя модели и поля запроса

В каталоге 1 запись семейства Grok Imagine: версии и режимы. Имя модели ставится в поле model запроса createTask, а всё остальное уходит вложенным объектом input. У каждой модели ниже её поля, готовый вызов и ответ; общее для всех изображений — на странице Изображения, а сам порядок вызова разобран в разделе Как устроена задача.

Модели семейства

Идентификатор Модель Задача Страница на сайте
grok-imagine/image-2-0-text-to-image Grok Imagine Image 2.0 text-to-image Открыть

grok-imagine/image-2-0-text-to-image

Поля запроса

ПолеТипОбяз.Допустимые значения
model текст обязательное grok-imagine/image-2-0-text-to-image
input объект обязательное Параметры генерации — поля из таблицы ниже

Поля input

ПолеТипОбяз.Допустимые значения
prompt текст обязательное от 1 до 5 000 символов
aspect_ratio значение из списка обязательное 1:1 · 2:3 · 3:2 · 16:9 · 9:16

Пример вызова

task.sh
# 1. Поставить задачу — в ответе придёт её номер
TASK=$(curl -s https://api.gen202.com/api/v1/jobs/createTask \
  -H "Authorization: Bearer sk-ваш-ключ" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "grok-imagine/image-2-0-text-to-image",
    "input": {
      "prompt": "Рыжий кот в скафандре на фоне Земли, мягкий свет",
      "aspect_ratio": "1:1"
    }
  }' | jq -r '.data.taskId')

# 2. Спрашивать состояние, пока задача не закончится: waiting, queuing и
#    generating означают «работа идёт», success и fail — окончательные
while true; do
  RECORD=$(curl -s "https://api.gen202.com/api/v1/jobs/recordInfo?taskId=$TASK" \
    -H "Authorization: Bearer sk-ваш-ключ")
  STATE=$(echo "$RECORD" | jq -r '.data.state')
  case "$STATE" in success|fail) break;; esac
  sleep 3
done

# 3. Забрать результат. Ссылка на файл лежит в resultJson — это строка JSON
#    внутри JSON, поэтому её разбирают вторым разбором (fromjson)
echo "$RECORD" | jq -r '.data |
  if .state == "fail"
  then "отказ \(.failCode): \(.failMsg)"
  else .resultJson | fromjson | .resultUrls[0]
  end'
task.py
import json
import time

import requests

headers = {"Authorization": "Bearer sk-ваш-ключ"}

# 1. Поставить задачу — в ответе придёт её номер
created = requests.post(
    "https://api.gen202.com/api/v1/jobs/createTask",
    headers=headers,
    json={
      "model": "grok-imagine/image-2-0-text-to-image",
      "input": {
        "prompt": "Рыжий кот в скафандре на фоне Земли, мягкий свет",
        "aspect_ratio": "1:1"
      }
    },
).json()
task_id = created["data"]["taskId"]

# 2. Спрашивать состояние, пока задача не закончится: waiting, queuing и
#    generating означают «работа идёт», success и fail — окончательные
while True:
    task = requests.get(
        "https://api.gen202.com/api/v1/jobs/recordInfo",
        headers=headers,
        params={"taskId": task_id},
    ).json()["data"]
    if task["state"] in ("success", "fail"):
        break
    time.sleep(3)

# 3. Разобрать итог. У неудачи причина в failCode и failMsg
if task["state"] == "fail":
    raise SystemExit("отказ " + task["failCode"] + ": " + task["failMsg"])

# resultJson — строка JSON внутри JSON, поэтому разбор второй
result = json.loads(task["resultJson"])
print(result["resultUrls"][0])
print("списано кредитов:", task["creditsConsumed"])

Пример проходит весь путь: ставит задачу, повторяет запрос состояния раз в 3 секунды, пока задача не закончится, и разбирает ответ до ссылки на файл. Разборов два, потому что поле resultJson — строка JSON внутри JSON. В теле первого запроса стоят обязательные поля модели и значения из её перечислений, поэтому он проходит проверку шлюза как есть. Подставить остаётся только свой ключ. Пример на оболочке разбирает ответ через jq; на Python своего ничего не нужно, кроме requests.

Ответ, когда задача готова

recordInfo.json
{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "cm8r4t0vk0001s60p2xq7f9ab",
    "model": "grok-imagine/image-2-0-text-to-image",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://file.example/result.jpg\"]}",
    "failCode": "",
    "failMsg": ""
  }
}

Ссылка на файл лежит в resultJson — это строка, внутри которой ещё один JSON, поэтому разбирать её нужно вторым разбором. Пока задача не завершилась, там пустая строка, а в statewaiting, queuing или generating. В настоящем ответе есть ещё поле creditsConsumed со списанием; здесь его нет намеренно — сумма зависит от запрошенного варианта, а цены живут в каталоге. Все поля записи перечислены в разделе Формат ответа.

Общее для всех моделей: Как устроена задача — чем отправить и как дождаться · Формат ответа — где в ответе ссылка на файл · Отказы — что означает отказ