reference_image_urlsarray<string>RequiredExactly one portrait of the person to keep. A sharp, front-facing photo with nothing covering the face works best; JPEG, PNG or WebP up to 10 MB.
- Default
- Not specified
- Constraints
- minItems:1maxItems:1
ideogram/character/text-to-imageIdeogram Character, Ideogram's July 2025 consistency model, takes one portrait and a written scene and returns up to four new images that keep that face and hairstyle, in Turbo, Balanced or Quality.
Filtering differs by endpoint: Text to image — Uncensored, Image editing — Softened.
Examples use the selected endpoint’s public parameter definitions. Replace the API key and example media, then send the request from your server.
SDKs & integrationshttps://api.spicyapi.ai/api/v1/jobs/createTaskKeep the API key in the server environment variable SPICY_API_KEY. Use Bearer authentication and Content-Type: application/json for JSON requests.
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"Generated from this model’s input schema — the same one the API validates every request against.
Place these fields inside the request body’s input object. Names and types match the API. Do not assume a default when none is specified.
reference_image_urlsarray<string>RequiredExactly one portrait of the person to keep. A sharp, front-facing photo with nothing covering the face works best; JPEG, PNG or WebP up to 10 MB.
promptstringRequiredDescribe the new scene in up to 5,000 characters: place, outfit, pose, light and camera. Refer to the person simply as the woman, the man or she.
seedintegerOptionalOptional integer. Reusing it with the same inputs makes one-change comparisons easier; it does not promise an identical image.
negative_promptstringOptionalOptional list of things to keep out, up to 5,000 characters. The main prompt wins when the two conflict.
enable_prompt_expansionbooleanOptionalMagicPrompt, on by default, expands a short prompt before rendering. Turn it off to have long prompts followed word for word.
num_outputsintegerOptionalAffects price1 to 4 images from the same prompt and reference. Each image is billed.
stylestringOptionalauto (default) lets the model choose; realistic aims for photography; fiction for illustration and stylised art. No price effect.
"auto""realistic""fiction"qualitystringOptionalAffects priceturbo, balanced (default) or quality. Higher tiers take longer and cost more per image.
"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 means the task was accepted, not completed. Save the returned taskId and query that task. Do not create another task while waiting for its result.
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"
}
}The accepted response includes the estimate so your app can show the same amount in task history and billing.
curl --get "https://api.spicyapi.ai/api/v1/jobs/recordInfo" \
--data-urlencode "taskId=$TASK_ID" \
-H "Authorization: Bearer $SPICY_API_KEY"Start polling at about 2 seconds and gradually increase the interval. Stop at a terminal state. After a connection failure, query the original taskId. Retry creation only with the original idempotency key and body.
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);
});Pass callBackUrl when you create the task and the finished record is POSTed to you — no polling loop at all. Every delivery carries X-Webhook-Timestamp, X-Webhook-Signature and X-Webhook-Payload-Version. The signature is a base64 HMAC-SHA256 over taskId.timestamp.sha256(body), so it must be checked against the raw bytes: parsing the JSON and re-serialising it changes them and the check will fail. Failed deliveries are retried, so the same taskId can arrive twice — make the handler idempotent. Answer 2xx first and do the work afterwards; a slow handler is treated as a failed delivery.
Consume output only when state is succeeded. On failure, use errorCode, errorMessage and request_id to investigate. Example costs and states do not represent an actual bill.
{
"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"
}
}For each available asset, open or download assets[].url directly without an API Authorization header. The signed URL expires at expiresAt; poll the task again to refresh it while the asset remains within its retention period. A pending or unavailable asset has no URL. Treat signed URLs as private.
Use SpicyAPI in your app, terminal, AI assistant or visual workflow. Choose a setup guide below.
You do not have to write any of the code above. Connect the MCP server once and any agent that speaks MCP — Claude Code, Codex, Cursor, Windsurf, VS Code, Gemini CLI, Cline, LibreChat — can run this model by name, or run it from your shell with a single command.
Use ideogram/character/text-to-image to generate a portrait of a dancer under neon light, and save it to ./out/.
The agent looks the model up in the live catalogue, uploads the local file for you, then shows the exact quote and its maximum charge and waits for your confirmation. Nothing is billed until you say yes.
claude mcp add spicyapi -e SPICY_API_KEY=$SPICY_API_KEY \
-- npx --yes --package=@spicyapi/mcp spicyapi-mcp
npx skills add spicyapi-ai/spicy-skillThe first line gives the agent the tools; the second gives it the Skill — the operating rules for them, so it quotes before it bills, uploads local files instead of pasting bytes, and reads the finished asset URL rather than guessing. Every other client takes the same server through its own config file: see the developer hub.
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"}' \
--waitThe input is this endpoint’s own schema, same as the examples above. --wait polls until the task is finished and prints it; add --yes to skip the confirmation prompt in CI. Set SPICY_API_KEY first — one key works for the API, the CLI and the MCP server.
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 only ever shortens the window — 30m, 1h, 7d, or 0 to delete as soon as the task reaches a terminal state. The value that actually applies is the shortest of your request, your account settings and the platform maximum, so read it back from the task record rather than assuming the number you asked for took effect. Passing a longer window than your account allows does nothing.
Install the SpicyAPI nodes from ComfyUI Manager or with the command below, then search for Ideogram Character · Character Generation on the canvas. The node has the same options as this page and shows its price before it runs.
cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapiThe embedded panel reads the same schema as this page, so it cannot drift from the API. If your docs need the content to be searchable, read the JSON under /api/embed/models/ and render it yourself.
<iframe src="https://spicyapi.ai/embed/en/models/ideogram-character/api?model=ideogram%2Fcharacter%2Ftext-to-image" width="100%" height="560" loading="lazy" title="Request example" style="border:1px solid rgba(0,0,0,.12)"></iframe>