Appearance
Grok Imagine - Text to Image
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Grok Imagine - Text to Image
deprecated: false
description: >
## 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.
:::
## Related Resources
**Market Overview**
Explore all available models
**Common API**
Check credits and account usage
operationId: grok-imagine-text-to-image
tags:
- docs/en/Market/Image Models/Grok Imagine
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
model:
type: string
enum:
- grok-imagine/text-to-image
default: grok-imagine/text-to-image
description: |-
The model name to use for generation. Required field.
- Must be `grok-imagine/text-to-image` for this endpoint
examples:
- grok-imagine/text-to-image
callBackUrl:
type: string
format: uri
description: >-
The URL to receive image generation task completion updates.
Optional but recommended for production use.
- System will POST task status and results to this URL when
image generation completes
- Callback includes generated image URLs and task
information
- Your callback endpoint should accept POST requests with
JSON payload containing image 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 image generation task
properties:
prompt:
type: string
description: >-
Text prompt describing the desired image. Required
field.
- Should be detailed and specific about the desired
visual elements
- Describe composition, style, lighting, mood, and other
visual details
- Maximum length: 5000 characters
- Supports English language prompts
examples:
- >-
Cinematic portrait of a woman sitting by a vinyl
record player, retro living room background, soft
ambient lighting, warm earthy tones, nostalgic 1970s
wardrobe, reflective mood, gentle film grain texture,
shallow depth of field, vintage editorial photography
style.
aspect_ratio:
type: string
description: >-
Specifies the width-to-height ratio of the generated
image. Controls the aspect ratio of the output.
- **2:3**: Portrait orientation (vertical)
- **3:2**: Landscape orientation (horizontal)
- **1:1**: Square format
- **16:9**: Wide screen format
- **9:16**: Tall screen format
Default: 1:1
enum:
- '2:3'
- '3:2'
- '1:1'
- '16:9'
- '9:16'
examples:
- '3:2'
nsfw_checker:
type: boolean
default: false
description: >-
Defaults to false. You can set it to false based on your
needs. If set to false, our content filtering will be
disabled, and all results will be returned directly by
the model itself.
enable_pro:
type: boolean
description: |-
Controls the request processing strategy.
- `false`: Corresponds to **speed mode**. The system prioritizes response time and throughput, suitable for latency-sensitive scenarios.
- `true`: Corresponds to **quality mode**. The system prioritizes processing quality and precision, suitable for scenarios requiring higher accuracy.
required:
- prompt
x-apidog-orders:
- prompt
- aspect_ratio
- nsfw_checker
- enable_pro
x-apidog-ignore-properties: []
required:
- model
- input
x-apidog-orders:
- model
- callBackUrl
- input
examples:
- model: grok-imagine/text-to-image
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Cinematic portrait of a woman sitting by a vinyl record
player, retro living room background, soft ambient
lighting, warm earthy tones, nostalgic 1970s wardrobe,
reflective mood, gentle film grain texture, shallow depth
of field, vintage editorial photography style.
aspect_ratio: '3:2'
x-apidog-ignore-properties: []
example:
model: grok-imagine/text-to-image
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Cinematic portrait of a woman sitting by a vinyl record
player, retro living room background, soft ambient lighting,
warm earthy tones, nostalgic 1970s wardrobe, reflective mood,
gentle film grain texture, shallow depth of field, vintage
editorial photography style.
aspect_ratio: '3:2'
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_grok_12345678
headers: {}
x-apidog-name: ''
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/Grok Imagine
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506368-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: []