Перейти к основному контенту

Редактирование по маске в Ideogram Character, модели от Ideogram, перерисовывает только чёрную область маски человеком с портрета-референса и сохраняет остальное изображение и его пропорции.

Фильтрация различается от эндпоинта к эндпоинту: Текст в изображение — Без цензуры, Редактирование изображений — Смягчается.

От $0.08/изобр.

Рабочая область

Отправить запрос

Быстрый старт

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

SDK и интеграции
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

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

Храните API-ключ в серверной переменной окружения SPICY_API_KEY. Используйте Bearer-аутентификацию и Content-Type: application/json для JSON-запросов.

Authorization: Bearer $SPICY_API_KEY
Ideogram Character · Character Inpaint · Пример результата
Пример результатаИспользовать пример
# Generate the idempotency key once; reuse it when retrying after a lost response.
export SPICY_IDEMPOTENCY_KEY="${SPICY_IDEMPOTENCY_KEY:-$(uuidgen)}"
curl -X POST https://api.spicyapi.ai/api/v1/jobs/createTask \
  -H "Authorization: Bearer $SPICY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SPICY_IDEMPOTENCY_KEY" \
  -d '{
  "model": "ideogram/character/edit",
  "input": {
    "image_url": "https://example.com/reference.png",
    "mask_url": "https://example.com/reference.png",
    "num_outputs": 1,
    "prompt": "A ceramic teapot on a linen cloth, soft window light, muted palette",
    "quality": "balanced",
    "reference_image_urls": [
      "https://example.com/reference.png"
    ],
    "style": "auto"
  }
}'

# Copy data.taskId from the response into TASK_ID, then poll the status.
TASK_ID="TASK_ID_FROM_RESPONSE"
curl "https://api.spicyapi.ai/api/v1/jobs/recordInfo?taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Пример построен по входной схеме этой модели — той же, по которой API проверяет каждый запрос.

Входные параметры

Поместите эти поля в объект input тела запроса. Имена и типы соответствуют API. Не предполагайте значение по умолчанию, если оно не задано.

mask_urlstringОбязательно

Чёрное — область для перерисовки, белое сохраняется. Используйте те же пропорции, что у image_url; маску можно нарисовать прямо на странице.

По умолчанию
Не задано
Ограничения
format:"uri"
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
reference_image_urlsarray<string>Обязательно

Ровно один портрет человека для замаскированной области, лицо хорошо видно, до 10 МБ.

По умолчанию
Не задано
Ограничения
minItems:1
maxItems:1
image_urlstringОбязательно

Изображение для правки в JPEG, PNG или WebP до 10 МБ. Результат сохраняет его пропорции.

По умолчанию
Не задано
Ограничения
format:"uri"
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
promptstringОбязательно

Опишите только то, что заполняет чёрную область: человека, выражение, одежду и свет, до 5000 символов.

По умолчанию
Не задано
Ограничения
minLength:1
maxLength:5000
seedintegerНеобязательно

Необязательное целое число для повторяемых сравнений; идентичное изображение не гарантируется.

По умолчанию
Не задано
Ограничения
minimum:0
maximum:2147483647
enable_prompt_expansionbooleanНеобязательно

MagicPrompt включён по умолчанию и переписывает короткие промпты перед рендерингом. Для длинных точных промптов выключите его.

По умолчанию
true
num_outputsintegerНеобязательноВлияет на цену

От 1 до 4 перерисованных вариантов за запрос; каждое изображение оплачивается.

По умолчанию
1
Ограничения
minimum:1
maximum:4
stylestringНеобязательно

auto (по умолчанию), realistic или fiction. Меняет облик, но не цену.

По умолчанию
"auto"
Допустимые значения
"auto""realistic""fiction"
qualitystringНеобязательноВлияет на цену

turbo, balanced (по умолчанию) или quality. Старшие уровни работают дольше и стоят дороже за изображение.

По умолчанию
"balanced"
Допустимые значения
"turbo""balanced""quality"

Отследить задачу

HTTP 202 означает принятие задачи, а не завершение генерации. Сохраните полученный taskId и проверяйте эту задачу. Не создавайте новую, пока ждёте результат.

Ответ при приёме задачи
HTTP/1.1 202 Accepted
Location: /api/v1/jobs/recordInfo?taskId=job_01k3m8x9q2z4v7n5p6r8s0t1w3

{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_create",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "state": "queued",
    "estimatedCost": "0.750000"
  }
}

В ответе о приёме есть оценка стоимости — приложение сможет показать ту же сумму в истории задач и в расчётах.

Получить задачу
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
  --data-urlencode "taskId=$TASK_ID" \
  -H "Authorization: Bearer $SPICY_API_KEY"

Начните с интервала около 2 секунд и постепенно увеличивайте его. Прекратите опрос при конечном состоянии. После сбоя соединения используйте исходный taskId. Повторно создавать задачу можно только с исходным ключом идемпотентности и исходным телом запроса.

Или пусть вызов придёт сам
import { verifyWebhook } from "@spicyapi/sdk";

// express.raw keeps the bytes we signed; express.json never matches.
app.post("/hooks/spicy", express.raw({ type: "application/json" }), (req, res) => {
  const { payload } = verifyWebhook({
    rawBody: req.body,
    timestamp: req.header("X-Webhook-Timestamp"),
    signature: req.header("X-Webhook-Signature"),
    payloadVersion: Number(req.header("X-Webhook-Payload-Version")),
    secret: process.env.SPICY_WEBHOOK_SECRET,
  });
  res.status(200).end();
  void handleFinishedTask(payload);
});

Передайте callBackUrl при создании задачи — готовая запись придёт к вам POST-запросом, и никакого опроса не понадобится. В каждой доставке есть X-Webhook-Timestamp, X-Webhook-Signature и X-Webhook-Payload-Version. Подпись — это HMAC-SHA256 в base64 от taskId.timestamp.sha256(body), поэтому проверять её нужно по исходным байтам: если разобрать JSON и сериализовать заново, байты изменятся и проверка не пройдёт. Неудачные доставки повторяются, так что один и тот же taskId может прийти дважды — сделайте обработчик идемпотентным. Сначала ответьте 2xx, работу выполняйте после: медленный обработчик считается неудачной доставкой.

Прочитать результат

Обрабатывайте output только при state, равном succeeded. При ошибке проверьте errorCode, errorMessage и request_id. Стоимость и состояния в примерах не являются фактическим счётом.

Пример ответа после завершения
{
  "code": 200,
  "msg": "success",
  "request_id": "req_example_record",
  "data": {
    "taskId": "job_01k3m8x9q2z4v7n5p6r8s0t1w3",
    "model": "ideogram/character/edit",
    "state": "succeeded",
    "output": {
      "assets": [
        {
          "key": "tasks/2026/08/28/job_01k3m8x9q2z4v7n5p6r8s0t1w3/3f7a1c9e5b2d48f0a6c1e3d5b7f9a1c3.png",
          "mime": "image/png",
          "url": "https://example.r2.cloudflarestorage.com/results/job_01k3m8x9q2z4v7n5p6r8s0t1w3/result.png?X-Amz-Signature=SIGNATURE_FROM_RESPONSE",
          "expiresAt": "2026-08-28T12:20:08.000Z"
        }
      ]
    },
    "cost": "0.750000",
    "settled": true,
    "createdAt": "2026-08-28T12:00:00Z",
    "completedAt": "2026-08-28T12:00:30Z"
  }
}

Доступные файлы можно открыть или скачать по assets[].url без заголовка API Authorization. Подписанная ссылка действует до expiresAt. Чтобы обновить её, повторно запросите задачу в течение срока хранения файла. У ожидающих или недоступных файлов URL отсутствует. Не передавайте подписанные ссылки посторонним.

SDK и интеграции

Используйте SpicyAPI в приложении, терминале, ИИ-ассистенте или визуальном процессе. Выберите руководство по настройке.

Использование в ComfyUI

Установите узлы SpicyAPI через ComfyUI Manager или командой ниже и найдите на холсте Ideogram Character · Character Inpaint. У узла те же параметры, что и на этой странице, а цена показывается до запуска.

cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi