Ideogram - character-remix
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
For production use, we recommend using the
callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.Related Resources
Rate limits and quotas are enforced by Apikley and may differ from upstream providers.
OpenAPI
market/ideogram/character-remix.json post /api/v1/jobs/createTask
Copy
openapi: 3.0.0
info:
title: Ideogram API
description: Apikley Ideogram API Documentation
version: 1.0.0
contact:
name: Technical Support
email: [email protected]
servers:
- url: https://api.apikley.ru
description: API Server
security:
- BearerAuth: []
paths:
/api/v1/jobs/createTask:
post:
summary: Generate content using ideogram/character-remix
operationId: ideogram-character-remix
requestBody:
required: true
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
example: 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
example: 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
example: >-
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
example: >-
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
example:
- >-
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
example: 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
example: 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
example: 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
example: square_hd
num_images:
description: Select description
type: string
enum:
- '1'
- '2'
- '3'
- '4'
default: '1'
example: '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
example: 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
example: ''
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
example: []
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
example: ''
required:
- prompt
- image_url
- reference_image_urls
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'
- type: object
properties:
data:
type: object
properties:
taskId:
type: string
description: >-
Task ID, can be used with Get Task Details
endpoint to query task status
example: task_ideogram_1765179916266
example:
code: 200
msg: success
data:
taskId: task_ideogram_1765179916266
'500':
$ref: '#/components/responses/Error'
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 455
- 500
- 501
- 505
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
- **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
msg:
type: string
description: Response message, error description when failed
example: success
responses:
Error:
description: Server Error
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: API Key
description: >-
All APIs require authentication via Bearer Token.
Get API Key:
1. Visit [API Key Management Page](https://app.apikley.ru/keys) to get your
API Key
Usage:
Add to request header:
Authorization: Bearer APIKLEY_API_KEY
Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately
in the management page
To find navigation and other pages in this documentation, fetch the llms.txt file at: https://docs.apikley.ru/llms.txt