reference_image_urlsarray<string>ОбязательноРовно один портрет человека, которого нужно сохранить. Лучше всего резкое фото анфас без помех на лице; JPEG, PNG или WebP до 10 МБ.
- По умолчанию
- Не задано
- Ограничения
- minItems:1maxItems:1
Ideogram Character — модель согласованности от Ideogram, вышедшая в июле 2025 года: по одному портрету и описанию сцены она возвращает до четырёх новых изображений с тем же лицом и причёской в Turbo, Balanced или Quality.
Фильтрация различается от эндпоинта к эндпоинту: Текст в изображение — Без цензуры, Редактирование изображений — Смягчается.
Примеры используют публичные параметры выбранного эндпоинта. Замените API-ключ и примеры медиафайлов, затем отправьте запрос со своего сервера.
SDK и интеграцииhttps://api.spicyapi.ai/api/v1/jobs/createTaskХраните API-ключ в серверной переменной окружения SPICY_API_KEY. Используйте Bearer-аутентификацию и Content-Type: application/json для JSON-запросов.
Authorization: Bearer $SPICY_API_KEY
# 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/text-to-image",
"input": {
"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. Не предполагайте значение по умолчанию, если оно не задано.
reference_image_urlsarray<string>ОбязательноРовно один портрет человека, которого нужно сохранить. Лучше всего резкое фото анфас без помех на лице; JPEG, PNG или WebP до 10 МБ.
promptstringОбязательноОпишите новую сцену до 5000 символов: место, одежду, позу, свет и камеру. Человека достаточно называть the woman, the man или she.
seedintegerНеобязательноНеобязательное целое число. Повторное использование с теми же входными данными упрощает сравнение одного изменения, но идентичное изображение не гарантируется.
negative_promptstringНеобязательноНеобязательный список того, чего не должно быть, до 5000 символов. При конфликте побеждает основной промпт.
enable_prompt_expansionbooleanНеобязательноMagicPrompt включён по умолчанию и расширяет короткий промпт перед рендерингом. Выключите его, чтобы длинный промпт выполнялся дословно.
num_outputsintegerНеобязательноВлияет на ценуОт 1 до 4 изображений по одному промпту и референсу. Каждое изображение оплачивается.
stylestringНеобязательноauto (по умолчанию) оставляет выбор модели; realistic стремится к фотографии, fiction — к иллюстрации и стилизованному арту. На цену не влияет.
"auto""realistic""fiction"qualitystringНеобязательноВлияет на ценуturbo, balanced (по умолчанию) или quality. Старшие уровни работают дольше и стоят дороже за изображение.
"turbo""balanced""quality"{
"additionalProperties": false,
"properties": {
"enable_prompt_expansion": {
"default": true,
"description": "Let Ideogram's MagicPrompt rewrite a short prompt into a fuller description before rendering. On by default.",
"type": "boolean",
"x-ui": {
"order": 40,
"widget": "switch"
}
},
"negative_prompt": {
"description": "Things to keep out of the image, as a short list. The main prompt wins where they conflict.",
"maxLength": 5000,
"type": "string",
"x-ui": {
"advanced": true,
"order": 30,
"widget": "textarea"
}
},
"num_outputs": {
"default": 1,
"description": "How many images to make in one request, 1 to 4. Each image is billed.",
"maximum": 4,
"minimum": 1,
"type": "integer",
"x-ui": {
"affects_price": true,
"order": 55,
"widget": "number"
}
},
"prompt": {
"description": "Describe the new scene for the person in the reference photo: setting, outfit, pose, light and camera.",
"maxLength": 5000,
"minLength": 1,
"type": "string",
"x-ui": {
"order": 100,
"primary": true,
"widget": "textarea"
}
},
"quality": {
"default": "balanced",
"description": "Rendering speed tier. turbo is fastest and cheapest, quality is slowest with the most detail. Priced per image.",
"enum": [
"turbo",
"balanced",
"quality"
],
"type": "string",
"x-ui": {
"affects_price": true,
"enum_labels": {
"balanced": "Balanced",
"quality": "Quality",
"turbo": "Turbo"
},
"order": 70,
"widget": "radio"
}
},
"reference_image_urls": {
"description": "Exactly one clear photo of the person to keep consistent: face visible, nothing covering it. JPEG, PNG or WebP, up to 10 MB.",
"items": {
"contentMediaType": [
"image/jpeg",
"image/png",
"image/webp",
"image/gif"
],
"format": "uri",
"minLength": 1,
"type": "string"
},
"maxItems": 1,
"minItems": 1,
"type": "array",
"x-ui": {
"accept": [
"image/jpeg",
"image/png",
"image/webp"
],
"max_size_mb": 10,
"order": 95,
"widget": "multi-upload"
}
},
"seed": {
"description": "Optional random seed. Reusing it keeps the same starting noise so one change at a time is easier to compare; results are not guaranteed to match exactly.",
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"x-ui": {
"advanced": true,
"order": 20,
"widget": "number"
}
},
"style": {
"default": "auto",
"description": "Look of the result: auto lets the model decide, realistic aims for photography, fiction for illustration and stylised art.",
"enum": [
"auto",
"realistic",
"fiction"
],
"type": "string",
"x-ui": {
"enum_labels": {
"auto": "Auto",
"fiction": "Fiction",
"realistic": "Realistic"
},
"order": 65,
"widget": "select"
}
}
},
"required": [
"prompt",
"reference_image_urls"
],
"type": "object",
"x-pricing": {
"billingMode": "variant_matrix",
"variantFields": [
"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/text-to-image",
"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 отсутствует. Не передавайте подписанные ссылки посторонним.
Используйте SpicyAPI в приложении, терминале, ИИ-ассистенте или визуальном процессе. Выберите руководство по настройке.
Писать код выше вовсе не обязательно. Подключите сервер MCP один раз — и любой агент, который говорит на MCP (Claude Code, Codex, Cursor, Windsurf, VS Code, Gemini CLI, Cline, LibreChat), вызовет эту модель по имени. Либо запустите её из терминала одной командой.
Возьми ideogram/character/text-to-image и сгенерируй портрет танцовщицы в неоновом свете, сохрани в ./out/.
Агент найдёт модель в каталоге, сам загрузит локальный файл, покажет точную смету и предельную сумму списания — и дождётся вашего согласия. До этого ничего не списывается.
claude mcp add spicyapi -e SPICY_API_KEY=$SPICY_API_KEY \
-- npx --yes --package=@spicyapi/mcp spicyapi-mcp
npx skills add spicyapi-ai/spicy-skillПервая строка даёт агенту инструменты, вторая — Skill, то есть правила обращения с ними: сначала смета, потом списание; локальные файлы загружать, а не вставлять байтами; URL готового результата читать, а не угадывать. Остальные клиенты подключают тот же сервер через собственный файл настроек — см. раздел для разработчиков.
npx @spicyapi/cli tasks create --model ideogram/character/text-to-image \
--input-json '{"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"}' \
--waitВходные данные взяты из схемы этого эндпоинта — той же, что и в примерах выше. --wait дождётся завершения задачи и выведет её, а --yes пропустит подтверждение в CI. Сначала задайте SPICY_API_KEY: один ключ работает и для API, и для CLI, и для сервера MCP.
npx @spicyapi/cli tasks create --model ideogram/character/text-to-image \
--input-json '{…}' --retention 1h --wait
npx @spicyapi/cli tasks get $TASK_ID # read back the retention that appliedКлюч --retention только сокращает срок — 30m, 1h, 7d или 0, чтобы удалить сразу после перехода задачи в конечное состояние. Реально действует наименьшее из трёх: ваш запрос, настройки аккаунта и предел платформы, — поэтому считайте его из записи задачи, а не исходите из того, что запрошенное число применилось. Запросить срок больше разрешённого аккаунтом нельзя: это ничего не изменит.
Установите узлы SpicyAPI через ComfyUI Manager или командой ниже и найдите на холсте Ideogram Character · Character Generation. У узла те же параметры, что и на этой странице, а цена показывается до запуска.
cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapiВстроенная панель читает ту же схему, что и эта страница, поэтому не может разойтись с API. Если содержимое должно индексироваться поиском по документации, возьмите JSON из /api/embed/models/ и отрисуйте его самостоятельно.
<iframe src="https://spicyapi.ai/embed/ru/models/ideogram-character/api?model=ideogram%2Fcharacter%2Ftext-to-image" width="100%" height="560" loading="lazy" title="Пример запроса" style="border:1px solid rgba(0,0,0,.12)"></iframe>