Ideogram - Character Remix

This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.

Endpoint

POST /jobs/createTask

Full URL: https://ai.modelfold.online/v1/jobs/createTask

Authentication: every request must include the Authorization: Bearer <API_KEY> header.

Image generation by ideogram/character-remix

Query Task Status

After submitting a task, use the unified query endpoint to check progress and retrieve results:

Get Task Details — Learn how to query task status and retrieve generation results

TIP

For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

Market Overview — Explore all available models
Common API — Check credits and account usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
`model`	`string`	Yes	The model name to use for generation. Required field. - Must be `ideogram/character-remix` for this endpoint Default：`"ideogram/character-remix"`。 Allowed values：`ideogram/character-remix`。示例：`ideogram/character-remix`。
`callBackUrl`	`string`	No	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例：`https://your-domain.com/api/callback`。
`input`	`object`	No	Input parameters for the generation task
`input.prompt`	`string`	Yes	The prompt to remix the image with (Max length: 5000 characters) 示例：A fisheye lens selfie photograph taken at night on an urban street. The image is circular with a black border and shows a person wearing dark sunglasses and a black jacket, holding a silver digital camera up to capture the reflection. The background shows a row of shuttered storefronts with red neon lighting visible in the upper portion. The street is empty and dark, with street lights creating a warm glow along the sidewalk. The fisheye effect creates a curved, distorted perspective that bends the straight lines of the street and buildings. The lighting is predominantly red and dark, creating a moody urban atmosphere. The person's reflection shows long dark hair and is positioned in the center of the circular frame. Multiple storefront shutters are visible in the background, creating a repeating pattern of horizontal lines. The overall composition has a cinematic quality with strong contrast between the dark street and the illuminated storefronts above.。
`input.image_url`	`string`	Yes	The image URL to remix (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) 示例：`https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp`。
`input.reference_image_urls`	`array<string>`	Yes	A set of images to use as character references. Currently only 1 image is supported, rest will be ignored. (maximum total size 10MB across all character references). The images should be in JPEG, PNG or WebP format (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)
`input.rendering_speed`	`string`	No	The rendering speed to use. Default value: "BALANCED" Default：`"BALANCED"`。 Allowed values：`TURBO` / `BALANCED` / `QUALITY`。示例：`BALANCED`。
`input.style`	`string`	No	The style type to generate with. Default value: "AUTO" Default：`"AUTO"`。 Allowed values：`AUTO` / `REALISTIC` / `FICTION`。示例：`AUTO`。
`input.expand_prompt`	`boolean`	No	Determine if MagicPrompt should be used in generating the request or not. Default value: true (Boolean value (true/false)) 示例：`true`。
`input.image_size`	`string`	No	Output image size. Default：`"square_hd"`。 Allowed values：`square` / `square_hd` / `portrait_4_3` / `portrait_16_9` / `landscape_4_3` / `landscape_16_9`。示例：`square_hd`。
`input.num_images`	`string`	No	Number of images to generate. Default：`"1"`。 Allowed values：`1` / `2` / `3` / `4`。示例：`1`。
`input.seed`	`integer`	No	Seed for the random number generator
`input.strength`	`number`	No	Strength of the input image in the remix Default value: 0.8 (Min: 0.1, Max: 1, Step: 0.1) (step: 0.1) Default：`0.8`。示例：`0.8`。
`input.negative_prompt`	`string`	No	Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: "" (Max length: 500 characters) 示例：``。
`input.image_urls`	`array<string>`	No	A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB)
`input.reference_mask_urls`	`string`	No	A set of masks to apply to the character references. Currently only 1 mask is supported, rest will be ignored. (maximum total size 10MB across all character references). The masks should be in JPEG, PNG or WebP format (File URL after upload, not file content; Accepted types: image/jpeg, image/png, image/webp; Max size: 10.0MB) 示例：``。

Request Example

bash

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "ideogram/character-remix",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A fisheye lens selfie photograph taken at night on an urban street. The image is circular with a black border and shows a person wearing dark sunglasses and a black jacket, holding a silver digital camera up to capture the reflection. The background shows a row of shuttered storefronts with red neon lighting visible in the upper portion. The street is empty and dark, with street lights creating a warm glow along the sidewalk. The fisheye effect creates a curved, distorted perspective that bends the straight lines of the street and buildings. The lighting is predominantly red and dark, creating a moody urban atmosphere. The person'\''s reflection shows long dark hair and is positioned in the center of the circular frame. Multiple storefront shutters are visible in the background, creating a repeating pattern of horizontal lines. The overall composition has a cinematic quality with strong contrast between the dark street and the illuminated storefronts above.",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "image_size": "square_hd",
    "num_images": "1",
    "strength": 0.8,
    "negative_prompt": "",
    "image_urls": [],
    "reference_mask_urls": ""
  }
}'

json

{
  "model": "ideogram/character-remix",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A fisheye lens selfie photograph taken at night on an urban street. The image is circular with a black border and shows a person wearing dark sunglasses and a black jacket, holding a silver digital camera up to capture the reflection. The background shows a row of shuttered storefronts with red neon lighting visible in the upper portion. The street is empty and dark, with street lights creating a warm glow along the sidewalk. The fisheye effect creates a curved, distorted perspective that bends the straight lines of the street and buildings. The lighting is predominantly red and dark, creating a moody urban atmosphere. The person's reflection shows long dark hair and is positioned in the center of the circular frame. Multiple storefront shutters are visible in the background, creating a repeating pattern of horizontal lines. The overall composition has a cinematic quality with strong contrast between the dark street and the illuminated storefronts above.",
    "image_url": "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "image_size": "square_hd",
    "num_images": "1",
    "strength": 0.8,
    "negative_prompt": "",
    "image_urls": [],
    "reference_mask_urls": ""
  }
}

Response

200 — Request successful

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_ideogram_1765179916266"
  }
}

Callback

onImageGenerated

Callback URL: {$request.body#/callBackUrl} (the callBackUrl in the request body).

Sent when the task succeeds or fails.

Callback body parameters

参数	类型	必填	说明
`code`	`integer`	否	200: success. 501: failure; see data.failCode and data.failMsg. Allowed values：`200` / `501`。示例：`200`。
`msg`	`string`	否	Status message 示例：`Playground task completed successfully.`。
`data`	`object`	否	—
`data.completeTime`	`integer`	否	Task completion time as a Unix timestamp in milliseconds 示例：`1786427040000`。
`data.costTime`	`integer`	否	Processing time in seconds. Present on both success and failure callbacks. 示例：`48`。
`data.createTime`	`integer`	否	Task creation time as a Unix timestamp in milliseconds 示例：`1786426989000`。
`data.creditsConsumed`	`number`	否	Credits consumed by the task; 0 for failed tasks. 示例：`18`。
`data.model`	`string`	否	Model used for image editing 示例：`ideogram/character-remix`。
`data.param`	`string`	否	Parameters submitted when creating the task, formatted as a JSON string 示例：{"model":"ideogram/character-remix","callBackUrl":"https://your-domain.com/api/callback","input":{"prompt":"A fisheye-lens selfie taken on a city street at night. The image is circular with a black border. The subject wears dark sunglasses and a black jacket,holding a silver digital camera up to capture their reflection. In the background, a row of closed storefront shutters is visible beneath red neon lights. The street is empty and dimly lit, with streetlights casting a warm glow onto the sidewalk. The fisheye effect creates a curved,distorted perspective, causing the straight lines of the street and buildings to appear arched. The image is dominated by red and dark tones,creating a highly atmospheric urban mood. The subject's reflection, with dark long hair visible, is positioned in the center of the circular frame. Multiple storefront shutters form repeating horizontal patterns in the background. The overall composition has a cinematic quality, with a strong contrast between the dim street and the brightly illuminated storefront above.","image_url":"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp","reference_image_urls":["https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"image_size":"square_hd","num_images":"1","strength":0.8,"negative_prompt":"","image_urls":[],"reference_mask_urls":""}}。
`data.resultJson`	`string`	否	Image generation result formatted as a JSON string. resultUrls contains the list of generated image URLs. Present only when state is success. 示例：`{"resultUrls":["https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.webp"]}`。
`data.state`	`string`	否	Task status Allowed values：`success` / `fail`。示例：`success`。
`data.taskId`	`string`	否	Task ID 示例：`4e029a320e97cff234e6e06827c3965e`。
`data.updateTime`	`integer`	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：`1786427040000`。
`data.failCode`	`string`	否	Failure code, a numeric string such as "400" or "500". Present only when state is fail. 示例：`500`。
`data.failMsg`	`string`	否	Failure reason. Present only when state is fail. 示例：`<error detail>`。

Success

json

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/character-remix",
    "state": "success",
    "param": "{\"model\":\"ideogram/character-remix\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"A fisheye-lens selfie taken on a city street at night. The image is circular with a black border. The subject wears dark sunglasses and a black jacket,holding a silver digital camera up to capture their reflection. In the background, a row of closed storefront shutters is visible beneath red neon lights. The street is empty and dimly lit, with streetlights casting a warm glow onto the sidewalk. The fisheye effect creates a curved,distorted perspective, causing the straight lines of the street and buildings to appear arched. The image is dominated by red and dark tones,creating a highly atmospheric urban mood. The subject's reflection, with dark long hair visible, is positioned in the center of the circular frame. Multiple storefront shutters form repeating horizontal patterns in the background. The overall composition has a cinematic quality, with a strong contrast between the dim street and the brightly illuminated storefront above.\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"image_size\":\"square_hd\",\"num_images\":\"1\",\"strength\":0.8,\"negative_prompt\":\"\",\"image_urls\":[],\"reference_mask_urls\":\"\"}}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.webp\"]}",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 18,
    "updateTime": 1786427040000
  }
}

Failure

json

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "4e029a320e97cff234e6e06827c3965e",
    "model": "ideogram/character-remix",
    "state": "fail",
    "param": "{\"model\":\"ideogram/character-remix\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"A fisheye-lens selfie taken on a city street at night. The image is circular with a black border. The subject wears dark sunglasses and a black jacket,holding a silver digital camera up to capture their reflection. In the background, a row of closed storefront shutters is visible beneath red neon lights. The street is empty and dimly lit, with streetlights casting a warm glow onto the sidewalk. The fisheye effect creates a curved,distorted perspective, causing the straight lines of the street and buildings to appear arched. The image is dominated by red and dark tones,creating a highly atmospheric urban mood. The subject's reflection, with dark long hair visible, is positioned in the center of the circular frame. Multiple storefront shutters form repeating horizontal patterns in the background. The overall composition has a cinematic quality, with a strong contrast between the dim street and the brightly illuminated storefront above.\",\"image_url\":\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"image_size\":\"square_hd\",\"num_images\":\"1\",\"strength\":0.8,\"negative_prompt\":\"\",\"image_urls\":[],\"reference_mask_urls\":\"\"}}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 0,
    "updateTime": 1786427040000
  }
}

Ideogram - Character Remix ​

Endpoint ​

Query Task Status ​

Related Resources ​

Request Parameters ​

Body (application/json) ​

Request Example ​

Response ​

200 — Request successful ​

Callback ​

onImageGenerated ​

Ideogram - Character Remix

Endpoint

Query Task Status

Related Resources

Request Parameters

Body (application/json)

Request Example

Response

200 — Request successful

Callback

onImageGenerated