Ideogram - Character

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

Output format: WebP.

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` for this endpoint Default：`"ideogram/character"`。 Allowed values：`ideogram/character`。示例：`ideogram/character`。
`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 describing the scene to generate with the referenced character. (Max length: 5000 characters) 示例：Place the woman from the uploaded portrait, wearing a casual white blouse, in a peaceful garden setting. The scene should feature vibrant green plants and colorful flowers, with soft sunlight filtering through the leaves. She should be sitting on a wooden bench, holding a book and smiling gently. The background should be filled with lush greenery, with a serene, tranquil atmosphere. Golden afternoon light should highlight the woman’s face and create soft shadows on the ground, adding a peaceful, reflective mood to the scene。
`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.num_images`	`string`	No	Number of images to generate. Default：`"1"`。 Allowed values：`1` / `2` / `3` / `4`。示例：`1`。
`input.image_size`	`string`	No	The resolution of the generated image Default value: square_hd Default：`"square_hd"`。 Allowed values：`square` / `square_hd` / `portrait_4_3` / `portrait_16_9` / `landscape_4_3` / `landscape_16_9`。示例：`square_hd`。
`input.seed`	`integer`	No	Seed for the random number generator
`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: 5000 characters) 示例：``。

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",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Place the woman from the uploaded portrait, wearing a casual white blouse, in a peaceful garden setting. The scene should feature vibrant green plants and colorful flowers, with soft sunlight filtering through the leaves. She should be sitting on a wooden bench, holding a book and smiling gently. The background should be filled with lush greenery, with a serene, tranquil atmosphere. Golden afternoon light should highlight the woman’s face and create soft shadows on the ground, adding a peaceful, reflective mood to the scene",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755767145415pvz49dpi.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "num_images": "1",
    "image_size": "square_hd",
    "negative_prompt": ""
  }
}'

json

{
  "model": "ideogram/character",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Place the woman from the uploaded portrait, wearing a casual white blouse, in a peaceful garden setting. The scene should feature vibrant green plants and colorful flowers, with soft sunlight filtering through the leaves. She should be sitting on a wooden bench, holding a book and smiling gently. The background should be filled with lush greenery, with a serene, tranquil atmosphere. Golden afternoon light should highlight the woman’s face and create soft shadows on the ground, adding a peaceful, reflective mood to the scene",
    "reference_image_urls": [
      "https://file.aiquickdraw.com/custom-page/akr/section-images/1755767145415pvz49dpi.webp"
    ],
    "rendering_speed": "BALANCED",
    "style": "AUTO",
    "expand_prompt": true,
    "num_images": "1",
    "image_size": "square_hd",
    "negative_prompt": ""
  }
}

Response

200 — Request successful

json

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

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 generation 示例：`ideogram/character`。
`data.param`	`string`	否	Parameters submitted when creating the task, formatted as a JSON string 示例：{"model":"ideogram/character","callBackUrl":"https://your-domain.com/api/callback","input":{"prompt":"Place the woman from the uploaded portrait, wearing a casual white shirt, in a serene garden setting. The scene should feature lush greenery and colorful flowers, with soft sunlight filtering through the foliage. She is seated on a wooden bench, holding a book and smiling gently. The background is filled with flourishing plants, creating a peaceful and tranquil atmosphere. Golden afternoon light outlines her face and casts soft shadows on the ground, adding a relaxed and contemplative mood to the entire image.","reference_image_urls":["https://file.aiquickdraw.com/custom-page/akr/section-images/1755767145415pvz49dpi.webp"],"rendering_speed":"BALANCED","style":"AUTO","expand_prompt":true,"num_images":"1","image_size":"square_hd","negative_prompt":""}}。
`data.resultJson`	`string`	否	Image generation result formatted as a JSON string. `resultUrls` contains the URLs of the generated images. 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",
    "state": "success",
    "param": "{\"model\":\"ideogram/character\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"Place the woman from the uploaded portrait, wearing a casual white shirt, in a serene garden setting. The scene should feature lush greenery and colorful flowers, with soft sunlight filtering through the foliage. She is seated on a wooden bench, holding a book and smiling gently. The background is filled with flourishing plants, creating a peaceful and tranquil atmosphere. Golden afternoon light outlines her face and casts soft shadows on the ground, adding a relaxed and contemplative mood to the entire image.\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755767145415pvz49dpi.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"num_images\":\"1\",\"image_size\":\"square_hd\",\"negative_prompt\":\"\"}}",
    "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",
    "state": "fail",
    "param": "{\"model\":\"ideogram/character\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"input\":{\"prompt\":\"Place the woman from the uploaded portrait, wearing a casual white shirt, in a serene garden setting. The scene should feature lush greenery and colorful flowers, with soft sunlight filtering through the foliage. She is seated on a wooden bench, holding a book and smiling gently. The background is filled with flourishing plants, creating a peaceful and tranquil atmosphere. Golden afternoon light outlines her face and casts soft shadows on the ground, adding a relaxed and contemplative mood to the entire image.\",\"reference_image_urls\":[\"https://file.aiquickdraw.com/custom-page/akr/section-images/1755767145415pvz49dpi.webp\"],\"rendering_speed\":\"BALANCED\",\"style\":\"AUTO\",\"expand_prompt\":true,\"num_images\":\"1\",\"image_size\":\"square_hd\",\"negative_prompt\":\"\"}}",
    "failCode": "500",
    "failMsg": "<error detail>",
    "completeTime": 1786427040000,
    "createTime": 1786426989000,
    "costTime": 48,
    "creditsConsumed": 0,
    "updateTime": 1786427040000
  }
}

Ideogram - Character ​

Endpoint ​

Query Task Status ​

Related Resources ​

Request Parameters ​

Body (application/json) ​

Request Example ​

Response ​

200 — Request successful ​

Callback ​

onImageGenerated ​

Ideogram - Character

Endpoint

Query Task Status

Related Resources

Request Parameters

Body (application/json)

Request Example

Response

200 — Request successful

Callback

onImageGenerated