Перейти к навигации

Grok Imagine Image 2.0

Создавайте или редактируйте одно изображение по тексту и с использованием до 5 референсных изображений, по единой цене за изображение.

  • Асинхронная обработка: запрос создания быстро возвращает ID задачи. Изображение будет доступно после её успешного завершения.
  • Одна задача создаёт одно изображение. Для нескольких изображений создайте несколько задач.
  • Генерация по тексту либо редактирование и объединение до 5 референсных изображений по общедоступным HTTPS-ссылкам.
  • Запрос содержит четыре поля: model, prompt, images, aspect_ratio. Настроек разрешения, качества, seed и формата результата нет.
  • Задача, завершившаяся ошибкой, не оплачивается: резерв возвращается полностью.
POST/v1/images/tasksПопробовать

Открывает модель в API Explorer. Введите свой API-ключ BeatAPI, чтобы создать задачу. Это настоящий запрос: его стоимость спишется с вашего баланса.

Адрес API и авторизация

POST https://api.beatapi.io/v1/images/tasks

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

Передавайте API-ключ BeatAPI как Bearer <BEATAPI_API_KEY>. Создать ключ можно в панели управления. Храните ключи на сервере, а не в коде браузерного или мобильного приложения.

Передавайте тело запроса в JSON с заголовком Content-Type: application/json. Idempotency-Key необязателен. Для каждого логического запроса используйте уникальное значение длиной не более 255 символов и повторно используйте его только для отправки точно такого же тела. В течение 24 часов повтор с тем же ключом и телом возвращает первый ответ с заголовком Idempotent-Replayed: true. Тот же ключ с другим телом возвращает 409 idempotency_conflict. Ответы, отличные от 2xx, не сохраняются, поэтому повтор после 400 или 402 выполняется заново.

Как выполняется запрос

1

Создайте задачу

Отправьте перечисленные ниже параметры методом POST на указанный адрес. Ответ 201 означает, что задача принята, а её стоимость зарезервирована на балансе. Обработка идёт в фоновом режиме. Сохраните data.id.

2

Дождитесь завершения

Вызывайте GET /v1/tasks/{task_id}, выдерживая между вызовами data.poll_after_seconds (5 с для изображений, 8 с для видео), пока status не станет succeeded или failed. Можно также настроить вебхук для событий task.succeeded и task.failed. Сохраняйте опрос как резервный способ проверки: задача, остановленная по тайм-ауту обработки, не отправляет событие.

3

Сохраните результат

При succeeded скачайте файлы по всем ссылкам data.output.media[].url и сохраните нужные результаты у себя. BeatAPI не гарантирует срок доступности этих ссылок. При failed прочитайте data.error_code и data.error_message: зарезервированная сумма возвращена на баланс, а data.retryable показывает, может ли повтор того же запроса завершиться успешно.

Режимы ввода

РежимОбязательные данныеПримечания
Изображение по текстуmodel, promptНе передавайте images.
Редактирование или объединение изображенийmodel, prompt, imagesОт 1 до 5 общедоступных HTTPS-ссылок на изображения. В prompt опишите, что изменить, сохранить или объединить.

Параметры запроса

model string Обязательно

Модель, которую нужно вызвать.

Значение: grok-imagine-image-2.0

Если значение неверно

  • Поле отсутствует: "model" is required
  • Неизвестный ID модели: "model" grok-imagine-image-9 is not catalogued
  • На этот адрес API отправлена видеомодель: "model" grok-imagine-video-1.5 is served by POST /v1/videos/tasks, not this endpoint

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

Что нарисовать либо изменить в референсных изображениях. Лучше писать обычным языком: объект, стиль, освещение, композиция и текст, который должен появиться на изображении.

Длина: 1–5000 символов

  • Длина измеряется в символах. Иероглиф CJK считается одним символом.
  • При передаче images укажите назначение каждого изображения, например «Сохрани товар с первого изображения и измени окружение».

Если значение неверно

  • Поле отсутствует: "prompt" is required
  • Пустое значение или превышена допустимая длина: "prompt" has an unsupported length
  • Значение не является строкой: "prompt" must be a string

images string[] Необязательно

Референсные изображения для редактирования или объединения. Поле переключает запрос с генерации по тексту на редактирование; отдельного переключателя режима нет.

Число элементов: 1–5
Каждый элемент — общедоступная ссылка https://. Если файл находится на вашем устройстве, сначала загрузите его через POST /v1/files, затем передайте полученный data.url.

  • Каждый элемент должен быть общедоступной ссылкой https:// на файл изображения. При создании задачи BeatAPI проверяет форму ссылки, но не скачивает изображение и не проверяет формат или размер; см. примечания под ограничениями.
  • Ссылки на веб-страницы, страницы входа, просроченные подписанные URL или защищённые от скачивания серверы не возвращают изображение и вызывают ошибку уже созданной задачи.
  • Индексы в сообщениях об ошибках начинаются с 0: images[0] — первая ссылка.

Если значение неверно

  • Превышено максимальное число элементов: "images" accepts at most 5 items
  • Пустой массив: "images" requires at least 1 item
  • Ссылка не начинается с https://: "images[0]" must be a public HTTPS URL
  • Значение не является массивом: "images" must be an array

Пример

"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png"
]

aspect_ratio string НеобязательноПо умолчанию: 1:1

Запрашиваемое соотношение ширины и высоты изображения.

Допустимые значения: auto, 1:1, 2:3, 3:2, 16:9, 9:16
По умолчанию: 1:1

  • auto оставляет выбор пропорций модели. Значение принимается только при передаче images.
  • Если поле не задано, используется 1:1, в том числе при передаче images.

Если значение неверно

  • Значение отсутствует в списке допустимых: "aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]
  • auto без images: Grok Imagine Image 2.0 aspect_ratio=auto requires at least one image

Ограничения входных материалов

До создания задачи шлюз проверяет каждый входной материал. Если ограничение нарушено, возвращается 400 bad_request с указанием материала. Средства не списываются.

  • Референсные изображения: от 1 до 5 общедоступных HTTPS-ссылок.
  • При создании задачи BeatAPI не скачивает файлы по этим ссылкам и не проверяет формат, размер файла или размеры в пикселях. Поэтому плохая ссылка не отклоняется заранее. Модель скачивает материалы самостоятельно.
  • Если модель не может скачать или прочитать материал, созданная задача завершается ошибкой, обычно bad_request, с возвратом средств. Используйте прямые ссылки на обычные файлы изображений с сервера, который отвечает на серверные запросы без входа в аккаунт.
  • Файл находится на вашем устройстве? Загрузите его через POST /v1/files и передайте полученный data.url.

Параметры, которые модель не принимает

API изображений знает несколько полей других моделей. Здесь они не игнорируются, а отклоняются, чтобы вы не платили за настройку без эффекта:

  • resolution, output_format, quality, seed, background, size, enhance_prompt → field "resolution" is not supported by model grok-imagine-image-2.0 (с именем переданного поля).
  • Любое другое неизвестное поле, например n → unknown field: n. Поля n нет: одна задача создаёт одно изображение.

Если неверных полей несколько, сообщение указывает только одно. Исправьте его и повторите запрос.

Поскольку поля output_format нет, сохраняется формат, возвращённый моделью. Проверьте его в output.media[].mime_type.

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

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-image-2.0",
"prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
"aspect_ratio": "3:2"
}'

Изображение по тексту

Горизонтальное изображение 3:2 по промпту.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-image-2.0",
"prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
"aspect_ratio": "3:2"
}'

Редактирование одного изображения

Сохранение товара с изменением окружения. Здесь auto разрешено, поскольку передано изображение.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-image-2.0",
"prompt": "Keep the bottle exactly as it is. Replace the background with a sunlit kitchen counter.",
"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png"
],
"aspect_ratio": "auto"
}'

Объединение нескольких изображений

Укажите каждый референс в промпте по его порядку.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-image-2.0",
"prompt": "Place the bottle from the first image on a neon-lit stage like the one in the second image.",
"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png",
"https://cdn.beatapi.io/samples/neon-singer.png"
],
"aspect_ratio": "16:9"
}'

Вертикальное изображение

Изображение 9:16 для экрана телефона.

curl --request POST \
--url https://api.beatapi.io/v1/images/tasks \
--header "Authorization: Bearer $BEATAPI_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"model": "grok-imagine-image-2.0",
"prompt": "A rain-soaked neon street at night seen from a low angle, a lone cyclist crossing the frame",
"aspect_ratio": "9:16"
}'

Ответы

Создание задачи (201)

Объект задачи. Поле output равно null, пока задача не завершится успешно. Поля с пометкой «во время выполнения» исчезают после завершения задачи.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "grok-imagine-image-2.0",
"capability_version": 1,
"media_type": "image",
"model": "grok-imagine-image-2.0",
"status": "queued",
"stage": "queued",
"created_at": 1791993600,
"updated_at": 1791993600,
"completed_at": null,
"poll_after_seconds": 5,
"output": null,
"usage": {
"credits_reserved": 0.03,
"credits_settled": 0,
"credits_refunded": 0,
"credits_charged": 0.03
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}
ПолеТипОписание
data.idstringID задачи: префикс task_ и 32 буквы или цифры. Используется для опроса и сопоставления событий вебхука.
data.objectstringВсегда task.
data.task_kindstringimage или video.
data.capability_idstringID модели из вашего запроса.
data.capability_versionintegerВерсия контракта модели, сейчас 1.
data.media_typestringimage или video.
data.modelstringID модели из запроса, совпадает с capability_id.
data.statusstringqueued, processing, succeeded или failed. Только последние два состояния являются конечными.
data.stagestringПовторяет status; сохранено для совместимости со старыми клиентами.
data.created_atintegerВремя создания задачи, в секундах Unix.
data.updated_atintegerВремя последнего изменения, в секундах Unix.
data.completed_atinteger | nullВремя завершения, в секундах Unix. Во время выполнения равно null.
data.poll_after_secondsintegerВо время выполнения: сколько секунд ждать перед следующей проверкой (5 для изображений, 8 для видео).
data.typical_secondsobjectВо время выполнения, при достаточном числе недавних задач: время завершения p50 и p90 в секундах за последний период window, рассчитанное по samples задачам.
data.outputobject | nullРезультат. Равно null, пока status не станет succeeded. Поля результата описаны ниже.
data.usage.credits_reservednumberСумма USD, зарезервированная на балансе при создании задачи.
data.usage.credits_chargednumberСтоимость задачи в USD; 0, если задача завершилась ошибкой.
data.usage.credits_settlednumberОкончательно списанная сумма USD. Устанавливается после успешного завершения, иначе 0.
data.usage.credits_refundednumberСумма USD, возвращённая на баланс. После регистрации возврата по неудачной задаче равна зарезервированной сумме.
data.usage.billable_duration_secondsintegerТолько для видео: длительность в секундах, по которой рассчитана цена. Отсутствует, если модель не сообщает длительность.
data.request_idstringID запроса. Укажите его при обращении в поддержку.
data.error_codestring | nullКод ошибки; null, если задача не завершилась ошибкой.
data.error_messagestring | nullОписание проблемы и способа её исправить; null, если задача не завершилась ошибкой.

Успешно завершённая задача

GET /v1/tasks/{task_id} возвращает HTTP 200 со status: "succeeded" и результатом в data.output.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "grok-imagine-image-2.0",
"capability_version": 1,
"media_type": "image",
"model": "grok-imagine-image-2.0",
"status": "succeeded",
"stage": "succeeded",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": {
"media": [
{
"type": "image",
"url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.jpg",
"mime_type": "image/jpeg"
}
],
"r2_url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.jpg"
},
"usage": {
"credits_reserved": 0.03,
"credits_settled": 0.03,
"credits_refunded": 0,
"credits_charged": 0.03
},
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": null,
"error_message": null
}
}

Поля результата

ПолеТипОписание
output.mediaobject[]Созданные файлы. Для этой модели — один элемент.
output.media[].typestringВсегда image.
output.media[].urlstringHTTPS-ссылка на сохранённое изображение. Скачайте его и храните у себя: срок доступности ссылки не гарантируется.
output.media[].mime_typestringСохранённый тип файла, например image/png или image/jpeg. У модели нет output_format, поэтому это формат, возвращённый моделью.
output.r2_urlstringПовтор первой ссылки на материал для старых клиентов. Вместо этого используйте media.

Задача, завершившаяся ошибкой

Если задача завершилась ошибкой, GET /v1/tasks/{task_id} всё равно возвращает HTTP 200: сведения об ошибке находятся в теле ответа. Зарезервированная сумма возвращается полностью, поэтому списания нет.

{
"data": {
"id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
"object": "task",
"task_kind": "image",
"capability_id": "grok-imagine-image-2.0",
"capability_version": 1,
"media_type": "image",
"model": "grok-imagine-image-2.0",
"status": "failed",
"stage": "failed",
"created_at": 1791993600,
"updated_at": 1791993690,
"completed_at": 1791993690,
"output": null,
"usage": {
"credits_reserved": 0.03,
"credits_settled": 0,
"credits_refunded": 0.03,
"credits_charged": 0
},
"retryable": true,
"request_id": "req_5f0c2a9e4b7d4e31",
"error_code": "processing_failed",
"error_message": "The task failed during processing on our side. Retry; a failed task is refunded."
}
}
ПолеТипОписание
data.error_codestringbad_request или content_policy_violation означают, что запрос нужно изменить. При processing_unavailable, processing_timeout, processing_failed или result_transfer_failed можно повторить позже. См. ошибки.
data.error_messagestringСообщение с причиной ошибки и рекомендацией по исправлению.
data.retryablebooleanПрисутствует только у неудачной задачи. Значение true означает, что повтор того же запроса может завершиться успешно.
data.usageobjectПосле регистрации возврата (обычно сразу при ошибке): credits_charged и credits_settled равны 0, а credits_refunded равно credits_reserved.

Полный пример

Создайте задачу, дождитесь её завершения с интервалом опроса, указанным сервером, и выведите ссылки на результаты. Задайте BEATAPI_API_KEY в переменной окружения и установите requests.

import os
import time
import uuid
import requests
API = "https://api.beatapi.io"
HEADERS = {"Authorization": f"Bearer {os.environ['BEATAPI_API_KEY']}"}
def create_task(body: dict) -> dict:
# One Idempotency-Key per logical request: a retry with the same key cannot create a second task.
headers = {**HEADERS, "Idempotency-Key": str(uuid.uuid4())}
for attempt in range(3):
response = requests.post(f"{API}/v1/images/tasks", headers=headers, json=body, timeout=60)
if response.status_code in (429, 503) and attempt < 2:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
break
try:
payload = response.json()
except ValueError: # an edge error page is not JSON
response.raise_for_status()
raise
if not response.ok:
error = payload["error"]
raise RuntimeError(f"{response.status_code} {error['code']}: {error['message']} (request_id={error.get('request_id')})")
return payload["data"]
def wait_for_task(task_id: str, timeout_seconds: int = 1800) -> dict:
deadline = time.monotonic() + timeout_seconds
while time.monotonic() < deadline:
response = requests.get(f"{API}/v1/tasks/{task_id}", headers=HEADERS, timeout=30)
if response.status_code == 429 or response.status_code >= 500:
time.sleep(int(response.headers.get("Retry-After", 10)))
continue
response.raise_for_status()
task = response.json()["data"]
if task["status"] in ("succeeded", "failed"):
return task
time.sleep(task.get("poll_after_seconds", 5))
raise TimeoutError(f"task {task_id} is still running; keep polling later")
task = create_task({
"model": "grok-imagine-image-2.0",
"prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
"aspect_ratio": "3:2"
})
print("created", task["id"])
task = wait_for_task(task["id"])
if task["status"] == "failed":
raise SystemExit(f"{task['error_code']}: {task['error_message']}")
for item in task["output"]["media"]:
print(item["url"])

Оплата

  • Одна задача создаёт одно изображение по единой базовой цене ниже. В прайс-листе для модели одна строка; параметров, меняющих цену, нет.
  • Стоимость резервируется при создании задачи на балансе и в лимите ключа, если он установлен. Запрос, отклонённый до создания задачи, не оплачивается.
  • При успешном завершении резерв списывается. При ошибке возвращается полностью: credits_refunded равно credits_reserved, а credits_charged и credits_settled равны 0.

Текущие базовые цены совпадают с указанными на странице цен. Если для аккаунта согласована скидка, стоимость будет ниже. Фактически списанная сумма всегда указана в data.usage задачи.

ВариантБазовая цена (USD)
1 изображение · текст в изображение · 1K$0.03

Частые ошибки

Ошибка или признак проблемыПричинаЧто делать
400 Grok Imagine Image 2.0 aspect_ratio=auto requires at least one imageaspect_ratio: "auto" в запросе генерации по тексту.Задайте соотношение сторон, например 1:1 или 16:9, либо передайте images.
400 "aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]Неподдерживаемое соотношение сторон, например 4:3 или 21:9.Выберите соотношение сторон из списка.
400 field "resolution" is not supported by model grok-imagine-image-2.0Передан параметр другой модели изображений: resolution, output_format, seed, quality, size, background, enhance_prompt.Удалите этот параметр.
400 unknown field: nЗапрошено несколько изображений в одной задаче.Удалите n и создайте отдельную задачу на каждое изображение.
400 "images" accepts at most 5 itemsБольше 5 референсных изображений.Передайте не более 5 ссылок.
400 "images[0]" must be a public HTTPS URLПередана ссылка http://, URI data: или локальный путь.Разместите файл по HTTPS либо загрузите через POST /v1/files и используйте data.url.
Задача failed с bad_request после передачи референсного изображенияСсылка открывает веб-страницу, страницу входа или просроченный подписанный URL либо сервер блокирует скачивание.Укажите прямую ссылку на изображение либо загрузите его через POST /v1/files. Средства не списаны.
400 aspect_ratio "9:16" is not available for this model right now; available: …Сейчас ни один доступный маршрут этой модели не принимает такое сочетание параметров.Используйте значение из списка либо повторите позже.
Задача failed с content_policy_violationПромпт, референсное или созданное изображение отклонены модерацией.Измените промпт или изображение. Повтор без изменений снова завершится ошибкой; средства не списаны.
Задача failed с processing_timeoutГенерация изображения не завершилась за отведённое время.Повторите запрос: за неудачную задачу средства возвращены.

Краткий справочник HTTP-ошибок

Ошибки до создания задачи возвращаются с HTTP-статусом, отличным от 2xx, без списания средств. Обрабатывайте error.code или error.retryable; причина указана в message. Полный список и правила повторов приведены в разделе ошибок.

{
"error": {
"code": "bad_request",
"message": "\"prompt\" is required",
"retryable": false,
"request_id": "req_5f0c2a9e4b7d4e31"
}
}
HTTP-статусerror.codeЧто делать
400bad_request, content_policy_violationИсправьте запрос: поле указано в сообщении. Не повторяйте запрос без изменений.
401missing_api_key, invalid_api_key (старые клиенты могут показывать unauthorized)Передайте действующий ключ в Authorization: Bearer <key>.
402insufficient_creditsПополните баланс или увеличьте лимит ключа, затем повторите запрос.
403forbiddenМодель недоступна для ключа или аккаунта; например, бонус можно использовать только с некоторыми моделями. Не повторяйте запрос без изменений.
404not_foundДля GET /v1/tasks/{task_id}: у аккаунта этого ключа нет такой задачи. Проверьте ID.
409idempotency_conflictИспользуйте новый Idempotency-Key или дождитесь завершения первого запроса с этим ключом.
429rate_limit_exceededПодождите число секунд из Retry-After (оно также указано в error.retry_after_seconds), затем повторите запрос.
500internal_errorПовторите запрос с увеличивающейся задержкой. Если ошибка сохраняется, обратитесь в поддержку и укажите request_id.
503processing_unavailable, processing_timeout, processing_failed, result_transfer_failedСредства не списаны. Повторите запрос с экспоненциальным увеличением задержки.

Аутентификация

AuthorizationBearer

Передавайте API-ключ в виде Authorization: Bearer <BEATAPI_API_KEY>.

Заголовки

Idempotency-KeystringОпциональный<=255 characters

Передавайте тело запроса в JSON с заголовком Content-Type: application/json. Idempotency-Key необязателен. Для каждого логического запроса используйте уникальное значение длиной не более 255 символов и повторно используйте его только для отправки точно такого же тела. В течение 24 часов повтор с тем же ключом и телом возвращает первый ответ с заголовком Idempotent-Replayed: true. Тот же ключ с другим телом возвращает 409 idempotency_conflict. Ответы, отличные от 2xx, не сохраняются, поэтому повтор после 400 или 402 выполняется заново.

Запрос

This endpoint expects an object.
modelenumОбязательный

Модель, которую нужно вызвать.

Значение: grok-imagine-image-2.0

Если значение неверно

  • Поле отсутствует: "model" is required
  • Неизвестный ID модели: "model" grok-imagine-image-9 is not catalogued
  • На этот адрес API отправлена видеомодель: "model" grok-imagine-video-1.5 is served by POST /v1/videos/tasks, not this endpoint
Допустимые значения:
promptstringОбязательный1-5000 characters

Что нарисовать либо изменить в референсных изображениях. Лучше писать обычным языком: объект, стиль, освещение, композиция и текст, который должен появиться на изображении.

Длина: 1–5000 символов

  • Длина измеряется в символах. Иероглиф CJK считается одним символом.
  • При передаче images укажите назначение каждого изображения, например «Сохрани товар с первого изображения и измени окружение».

Если значение неверно

  • Поле отсутствует: "prompt" is required
  • Пустое значение или превышена допустимая длина: "prompt" has an unsupported length
  • Значение не является строкой: "prompt" must be a string
aspect_ratioenumОпциональныйПо умолчанию 1:1

Запрашиваемое соотношение ширины и высоты изображения.

Допустимые значения: auto, 1:1, 2:3, 3:2, 16:9, 9:16

По умолчанию: 1:1

  • auto оставляет выбор пропорций модели. Значение принимается только при передаче images.
  • Если поле не задано, используется 1:1, в том числе при передаче images.

Если значение неверно

  • Значение отсутствует в списке допустимых: "aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]
  • auto без images: Grok Imagine Image 2.0 aspect_ratio=auto requires at least one image
imageslist of stringsОпциональный

Референсные изображения для редактирования или объединения. Поле переключает запрос с генерации по тексту на редактирование; отдельного переключателя режима нет.

Число элементов: 1–5

Каждый элемент — общедоступная ссылка https://. Если файл находится на вашем устройстве, сначала загрузите его через POST /v1/files, затем передайте полученный data.url.

  • Каждый элемент должен быть общедоступной ссылкой https:// на файл изображения. При создании задачи BeatAPI проверяет форму ссылки, но не скачивает изображение и не проверяет формат или размер; см. примечания под ограничениями.
  • Ссылки на веб-страницы, страницы входа, просроченные подписанные URL или защищённые от скачивания серверы не возвращают изображение и вызывают ошибку уже созданной задачи.
  • Индексы в сообщениях об ошибках начинаются с 0: images[0] — первая ссылка.

Если значение неверно

  • Превышено максимальное число элементов: "images" accepts at most 5 items
  • Пустой массив: "images" requires at least 1 item
  • Ссылка не начинается с https://: "images[0]" must be a public HTTPS URL
  • Значение не является массивом: "images" must be an array

Пример

"images": [
  "https://cdn.beatapi.io/samples/smart-bottle.png"
]

Ответ

Объект задачи. Поле output равно null, пока задача не завершится успешно. Поля с пометкой «во время выполнения» исчезают после завершения задачи.

Ошибки

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error