Skip to main content

Ideogram Character's masked edit from Ideogram repaints only the black area of your mask with the person from one reference portrait, keeping the rest of the picture and its proportions.

Filtering differs by endpoint: Text to image — Uncensored, Image editing — Softened.

From $0.08/image

Workbench

Send a request

Quickstart

Examples use the selected endpoint’s public parameter definitions. Replace the API key and example media, then send the request from your server.

SDKs & integrations
POSThttps://api.spicyapi.ai/api/v1/jobs/createTask

API authentication

Keep 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
Ideogram Character · Character Inpaint · Sample output
Sample outputUse this example
# 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"

Generated from this model’s input schema — the same one the API validates every request against.

Input parameters

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.

mask_urlstringRequired

Black marks the area to repaint, white is kept. Use the same proportions as image_url; you can draw it on the page.

Default
Not specified
Constraints
format:"uri"
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
reference_image_urlsarray<string>Required

Exactly one portrait of the person to place in the masked area, face clearly visible, up to 10 MB.

Default
Not specified
Constraints
minItems:1
maxItems:1
image_urlstringRequired

The picture to edit: JPEG, PNG or WebP up to 10 MB. The result keeps its proportions.

Default
Not specified
Constraints
format:"uri"
contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
promptstringRequired

Describe only what fills the black area: the person, expression, clothing and light, up to 5,000 characters.

Default
Not specified
Constraints
minLength:1
maxLength:5000
seedintegerOptional

Optional integer for repeatable comparisons; it does not guarantee an identical image.

Default
Not specified
Constraints
minimum:0
maximum:2147483647
enable_prompt_expansionbooleanOptional

MagicPrompt, on by default, rewrites short prompts before rendering. Turn it off for exact long prompts.

Default
true
num_outputsintegerOptionalAffects price

1 to 4 repainted versions per request; each image is billed.

Default
1
Constraints
minimum:1
maximum:4
stylestringOptional

auto (default), realistic or fiction. Changes the look, not the price.

Default
"auto"
Allowed values
"auto""realistic""fiction"
qualitystringOptionalAffects price

turbo, balanced (default) or quality. Higher tiers take longer and cost more per image.

Default
"balanced"
Allowed values
"turbo""balanced""quality"

Track the task

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.

Accepted response
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.

Read the job
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.

Or let the callback find you
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.

Read the result

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.

Completed response example
{
  "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"
  }
}

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.

SDKs & integrations

Use SpicyAPI in your app, terminal, AI assistant or visual workflow. Choose a setup guide below.

Use it in ComfyUI

Install the SpicyAPI nodes from ComfyUI Manager or with the command below, then search for Ideogram Character · Character Inpaint 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-spicyapi