Appearance
Ideogram V3 Edit
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Ideogram V3 Edit
deprecated: false
description: >
Image generation by ideogram/v3-edit
## Create Task
Use this endpoint to create a new image editing generation task.
**Get Task Details**
After submission, use the unified query endpoint to check task progress and retrieve results
::: tip[]
For production use, we recommend providing the `callBackUrl` parameter
so your service can receive completion notifications instead of polling
for task status.
:::
## Related Resources
**Model Marketplace**
Explore all available models and capabilities
**Common API**
Check account credits and usage
operationId: ideogram-v3-edit
tags:
- docs/en/Market/Image Models/Ideogram
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- ideogram/v3-edit
default: ideogram/v3-edit
description: |-
The model name used for generation. This field is required.
- This endpoint must use the `ideogram/v3-edit` model
examples:
- ideogram/v3-edit
callBackUrl:
type: string
format: uri
description: >-
Callback URL for task completion notifications. Optional
parameter. If provided, the system will send a POST request
to this URL when the task completes, whether it succeeds or
fails. If omitted, no callback notification will be sent.
examples:
- https://your-domain.com/api/callback
input:
type: object
description: Input parameters for the image editing task.
required:
- prompt
- image_url
- mask_url
properties:
prompt:
type: string
maxLength: 5000
description: >-
The prompt to fill the masked part of the image. Maximum
length: 5000 characters.
examples:
- A dog wearing a cowboy hat
image_url:
type: string
format: uri
description: >-
The image URL to generate an image from. Needs to match
the dimensions of the mask.
- Please provide the URL of the uploaded file, not raw
file content
- Accepted types: `image/jpeg`, `image/png`,
`image/webp`
- Max size: 10.0MB
examples:
- >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp
mask_url:
type: string
format: uri
description: >-
The mask URL to inpaint the image. Needs to match the
dimensions of the input image.
- Please provide the URL of the uploaded file, not raw
file content
- Accepted types: `image/jpeg`, `image/png`,
`image/webp`
- Max size: 10.0MB
examples:
- >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp
rendering_speed:
type: string
enum:
- TURBO
- BALANCED
- QUALITY
default: BALANCED
description: |-
The rendering speed to use. Default value: `BALANCED`.
- `TURBO`: Turbo
- `BALANCED`: Balanced
- `QUALITY`: Quality
examples:
- BALANCED
expand_prompt:
type: boolean
default: true
description: >-
Determine if MagicPrompt should be used in generating
the request or not. Default value: `true`.
- Boolean value: `true` / `false`
examples:
- true
seed:
type: integer
description: Seed for the random number generator.
x-apidog-orders:
- prompt
- image_url
- mask_url
- rendering_speed
- expand_prompt
- seed
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: ideogram/v3-edit
callBackUrl: https://your-domain.com/api/callback
input:
prompt: A dog wearing a cowboy hat
image_url: >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755076859801ryyol1du.webp
mask_url: >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1755076871089hx9uonhc.webp
rendering_speed: BALANCED
expand_prompt: true
seed: 123456
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, which can be used to query task status
through the task detail endpoint.
examples:
- task_ideogram_1765180586443
x-apidog-orders:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- data
x-apidog-ignore-properties: []
example:
code: 200
msg: success
data:
taskId: task_ideogram_1765180586443
headers: {}
x-apidog-name: ''
'500':
description: 请求失败
content:
application/json:
schema:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
headers: {}
x-apidog-name: Error
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
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-31157352-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: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 API Key 泄露，请立即在管理页面重置
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 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: []