mask_urlstring必須黒が描き直す部分、白が残す部分です。image_url と同じ比率にしてください。ページ上で直接描くこともできます。
- デフォルト値
- 指定なし
- 制約
- format:"uri"contentMediaType:["image/jpeg","image/png","image/webp","image/gif"]
Ideogram のマスク編集 Ideogram Character は、マスクの黒い部分だけを参考ポートレートの人物で描き直し、画像のほかの部分と縦横比はそのまま保ちます。
エンドポイントごとにフィルタリングの扱いが異なります:テキストから画像 — 規制なし, 画像編集 — 置き換え。
例は、選択中のエンドポイントの公開パラメーター定義から作っています。API キーとサンプル素材を差し替えて、ご自身のサーバーから送信してください。
SDK・連携https://api.spicyapi.ai/api/v1/jobs/createTaskAPI キーはサーバーの環境変数 SPICY_API_KEY に保存します。Bearer 認証を使用し、JSON リクエストには Content-Type: application/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/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 と同じ比率にしてください。ページ上で直接描くこともできます。
reference_image_urlsarray<string>必須マスク部分に入れる人物のポートレートをちょうど 1 枚。顔がはっきり見えるもので、10 MB まで。
image_urlstring必須編集する画像で、形式は JPEG、PNG、WebP、サイズは 10 MB までです。結果はこの画像の比率を保ちます。
promptstring必須マスクの黒い部分を埋める内容だけを書きます。人物、表情、服装、光を 5,000 文字以内で。
seedinteger任意比較をくり返すための任意の整数。同じ画像になる保証はありません。
enable_prompt_expansionboolean任意MagicPrompt は既定でオンで、短いプロンプトを描画前に書き換えます。長く正確なプロンプトではオフにします。
num_outputsinteger任意料金に影響1 回のリクエストで描き直した版を 1〜4 枚。1 枚ごとに課金されます。
stylestring任意auto(既定)、realistic、fiction。見た目が変わり、料金は変わりません。
"auto""realistic""fiction"qualitystring任意料金に影響turbo、balanced(既定)、quality。上位の段階ほど時間がかかり、1 枚あたりの料金も上がります。
"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"
}
},
"image_url": {
"contentMediaType": [
"image/jpeg",
"image/png",
"image/webp",
"image/gif"
],
"description": "The picture to work on. JPEG, PNG or WebP, up to 10 MB.",
"format": "uri",
"type": "string",
"x-ui": {
"accept": [
"image/jpeg",
"image/png",
"image/webp"
],
"max_size_mb": 10,
"order": 98,
"widget": "upload"
}
},
"mask_url": {
"contentMediaType": [
"image/jpeg",
"image/png",
"image/webp",
"image/gif"
],
"description": "Mask with the same proportions as image_url. Black marks the area to repaint with the character; white is kept unchanged.",
"format": "uri",
"type": "string",
"x-ui": {
"accept": [
"image/png",
"image/jpeg",
"image/webp"
],
"mask": {
"edit": "black",
"source": "image_url"
},
"max_size_mb": 10,
"order": 92,
"widget": "upload"
}
},
"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 what fills the black area of the mask: the person, their expression, clothing and light. The rest of the picture is kept.",
"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",
"image_url",
"mask_url",
"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 が付きます。署名は taskId.timestamp.sha256(body) に対する HMAC-SHA256(base64)なので、生のバイト列で検証してください。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 ヘッダーは不要です。署名付き URL は expiresAt で失効しますが、保存期間内であればタスクを再取得することで更新できます。処理中または利用できないファイルに URL はありません。署名付き URL は非公開情報として扱ってください。
アプリ、ターミナル、AI アシスタント、ビジュアルワークフローで SpicyAPI を活用。接続ガイドを選んでください。
上のコードを書く必要はありません。MCP サーバーを 1 回接続すれば、MCP に対応するエージェント(Claude Code、Codex、Cursor、Windsurf、VS Code、Gemini CLI、Cline、LibreChat)がこのモデルを名前で実行できます。シェルから 1 つのコマンドで実行することもできます。
Use ideogram/character/edit to edit ./poster.png — warmer light, cleaner background — and save the result next to it.
エージェントは公開カタログからモデルを引き、ローカルファイルを代わりにアップロードし、正確な見積もりと上限額を示して確認を待ちます。承認するまで課金は発生しません。
claude mcp add spicyapi -e SPICY_API_KEY=$SPICY_API_KEY \
-- npx --yes --package=@spicyapi/mcp spicyapi-mcp
npx skills add spicyapi-ai/spicy-skill1 行目でツールを、2 行目で Skill を渡します。Skill は使い方の取り決めです——課金の前に見積もりを取り、ローカルファイルはバイト列を貼らずにアップロードし、完成した成果物の URL を推測せずに読む。ほかのクライアントも同じサーバーをそれぞれの設定ファイルから使います。開発者向けページをご覧ください。
npx @spicyapi/cli tasks create --model ideogram/character/edit \
--input-json '{"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"}' \
--wait入力は上の例と同じ、このエンドポイント固有のスキーマに従います。--wait はタスクの完了までポーリングして結果を表示します。CI では --yes を追加すると確認を省略できます。先に SPICY_API_KEY を設定してください。API、CLI、MCP サーバーで同じキーを使えます。
npx @spicyapi/cli files upload ./poster.png
# -> spicy://uploads/01k3m8x9q2z4v7n5p6r8s0t1w3
npx @spicyapi/cli tasks create --model ideogram/character/edit \
--input-json '{"image_url":"spicy://uploads/01k3m8x9q2z4v7n5p6r8s0t1w3"}' \
--waitリクエストが受け取るのは URL であってバイト列ではありません。先にアップロードし、出力される spicy:// URI を渡してください。上のフィールド名はこのエンドポイントのスキーマから取ったものです。MCP 経由のエージェントはこの手順を代わりに済ませます——前述の一文が ./poster.png をそのまま指せるのはそのためです。公開 HTTPS で参照できるメディアならアップロードは不要です。
npx @spicyapi/cli tasks create --model ideogram/character/edit \
--input-json '{…}' --retention 1h --wait
npx @spicyapi/cli tasks get $TASK_ID # read back the retention that applied--retention は保持期間を短くするだけです——30m、1h、7d、あるいは 0 なら終了と同時に削除。実際に効くのはリクエスト・アカウント設定・プラットフォーム上限のうち最も短い値なので、指定した数値が通った前提で進めず、タスクレコードから読み戻してください。アカウントの許容より長い値を渡しても何も起きません。
ComfyUI Manager か下のコマンドで SpicyAPI ノードをインストールしたら、キャンバスで Ideogram Character · Character Inpaint を検索してください。このノードにはこのページと同じオプションがあり、実行前に価格が表示されます。
cd ComfyUI/custom_nodes
git clone https://github.com/spicyapi-ai/comfyui-spicyapi埋め込みパネルはこのページと同じスキーマを参照するため、API 仕様とのずれを防げます。ドキュメント内の検索対象にする場合は、/api/embed/models/ の JSON を取得して描画してください。
<iframe src="https://spicyapi.ai/embed/ja/models/ideogram-character/api?model=ideogram%2Fcharacter%2Fedit" width="100%" height="560" loading="lazy" title="リクエスト例" style="border:1px solid rgba(0,0,0,.12)"></iframe>