# Ideogram - Character Remix
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Ideogram - Character Remix
deprecated: false
description: >-
Image generation by ideogram/character-remix
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
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.
:::
## Related Resources
Explore all available models
Check credits and account usage
operationId: ideogram-character-remix
tags:
- docs/en/Market/Image Models/Ideogram
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- ideogram/character-remix
default: ideogram/character-remix
description: |-
The model name to use for generation. Required field.
- Must be `ideogram/character-remix` for this endpoint
examples:
- ideogram/character-remix
callBackUrl:
type: string
format: uri
description: >-
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](/common-api/webhook-verification) for signature
verification implementation
examples:
- https://your-domain.com/api/callback
input:
type: object
description: Input parameters for the generation task
properties:
prompt:
description: >-
The prompt to remix the image with (Max length: 5000
characters)
type: string
maxLength: 5000
examples:
- >-
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:
description: >-
The image URL to remix (File URL after upload, not file
content; Accepted types: image/jpeg, image/png,
image/webp; Max size: 10.0MB)
type: string
examples:
- >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755768466167d0tiuc6e.webp
reference_image_urls:
description: >-
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)
type: array
items:
type: string
format: uri
examples:
- - >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755768479029sugx0g6f.webp
rendering_speed:
description: 'The rendering speed to use. Default value: "BALANCED"'
type: string
enum:
- TURBO
- BALANCED
- QUALITY
default: BALANCED
examples:
- BALANCED
style:
description: >-
The style type to generate with. Cannot be used with
style_codes. Default value: "AUTO"
type: string
enum:
- AUTO
- REALISTIC
- FICTION
default: AUTO
examples:
- AUTO
expand_prompt:
description: >-
Determine if MagicPrompt should be used in generating
the request or not. Default value: true (Boolean value
(true/false))
type: boolean
examples:
- true
image_size:
description: Select description
type: string
enum:
- square
- square_hd
- portrait_4_3
- portrait_16_9
- landscape_4_3
- landscape_16_9
default: square_hd
examples:
- square_hd
num_images:
description: Select description
type: string
enum:
- '1'
- '2'
- '3'
- '4'
default: '1'
examples:
- '1'
seed:
description: Seed for the random number generator
type: integer
strength:
description: >-
Strength of the input image in the remix Default value:
0.8 (Min: 0.1, Max: 1, Step: 0.1) (step: 0.1)
type: number
minimum: 0.1
maximum: 1
default: 0.8
examples:
- 0.8
negative_prompt:
description: >-
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)
type: string
maxLength: 500
examples:
- ''
image_urls:
description: >-
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)
type: array
items:
type: string
format: uri
examples:
- []
reference_mask_urls:
description: >-
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)
type: string
examples:
- ''
required:
- prompt
- image_url
- reference_image_urls
x-apidog-orders:
- prompt
- image_url
- reference_image_urls
- rendering_speed
- style
- expand_prompt
- image_size
- num_images
- seed
- strength
- negative_prompt
- image_urls
- reference_mask_urls
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
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: ''
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_ideogram_1765179916266
headers: {}
x-apidog-name: ''
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
callbacks:
onImageGenerated:
'{$request.body#/callBackUrl}':
post:
summary: Image Generation Callback
description: >-
When the image generation task is completed, the system will
send the result to the callback URL you provided via a POST
request.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: >-
Status code
- **200**: Success - The image generation task was
completed successfully
- **400**: Invalid request parameters or content
policy violation
- **500**: Internal error, please try again later
- **501**: Failed - The image generation task failed
enum:
- 200
- 400
- 500
- 501
msg:
type: string
description: Status message
example: Playground task completed successfully.
data:
type: object
properties:
completeTime:
type: integer
format: int64
description: >-
Task completion time as a Unix timestamp in
milliseconds
example: 1786427040000
costTime:
type: integer
description: Task processing time in seconds
example: 48
createTime:
type: integer
format: int64
description: >-
Task creation time as a Unix timestamp in
milliseconds
example: 1786426989000
creditsConsumed:
type: number
format: double
description: Number of credits consumed by the task
example: 8
model:
type: string
description: Model used for image editing
example: ideogram/character-remix
param:
type: string
description: >-
Parameters submitted when creating the task,
formatted as a JSON string
example: >-
{"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:
type: string
description: >-
Image generation result formatted as a JSON
string. resultUrls contains the list of
generated image URLs
example: >-
{"resultUrls":["https://tempfile.aiquickdraw.com/workers/images/image_90b6bf4499a80b74a2b5ee640b7aaf70.jpg"]}
state:
type: string
description: Task status
enum:
- success
- fail
example: success
taskId:
type: string
description: Task ID
example: 4e029a320e97cff234e6e06827c3965e
updateTime:
type: integer
format: int64
description: >-
Last task update time as a Unix timestamp in
milliseconds
example: 1786427040000
responses:
'200':
description: Callback received successfully
x-apidog-folder: docs/en/Market/Image Models/Ideogram
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506378-run
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
description: >-
Response status code
- **200**: Success - Request has been processed successfully
- **401**: Unauthorized - Authentication credentials are missing or
invalid
- **402**: Insufficient Credits - Account does not have enough
credits to perform the operation
- **404**: Not Found - The requested resource or endpoint does not
exist
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **433**: Request Limit - Sub-key Usage Exceeds Limit
- **455**: Service Unavailable - System is currently undergoing
maintenance
- **500**: Server Error - An unexpected error occurred while
processing the request
- **501**: Generation Failed - Content generation task failed
- **505**: Feature Disabled - The requested feature is currently
disabled
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 433
- 455
- 500
- 501
- 505
x-apidog-enum:
- value: 200
name: ''
description: ''
- value: 401
name: ''
description: ''
- value: 402
name: ''
description: ''
- value: 404
name: ''
description: ''
- value: 422
name: ''
description: ''
- value: 429
name: ''
description: ''
- value: 433
name: ''
description: ''
- value: 455
name: ''
description: ''
- value: 500
name: ''
description: ''
- value: 501
name: ''
description: ''
- value: 505
name: ''
description: ''
msg:
type: string
description: Response message, error description when failed
examples:
- success
data:
type: object
properties:
taskId:
type: string
description: >-
Task ID, can be used with Get Task Details endpoint to query
task status
x-apidog-orders:
- taskId
required:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
title: response not with recordId
required:
- data
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
BearerAuth:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
All API requests require a Bearer Token. Add the header `Authorization:
Bearer YOUR_API_KEY` to authenticate requests.
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
所有 API 请求都需要 Bearer Token。请在请求头中添加 `Authorization: Bearer YOUR_API_KEY`
进行身份验证。
servers:
- url: https://api.kie.ai
description: 正式环境
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
```