Appearance
Grok Imagine Text to Video
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 Video
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-video
tags:
- docs/en/Market/Video Models/Grok Imagine
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
model:
type: string
enum:
- grok-imagine/text-to-video
default: grok-imagine/text-to-video
description: |-
The model name to use for generation. Required field.
- Must be `grok-imagine/text-to-video` for this endpoint
examples:
- grok-imagine/text-to-video
callBackUrl:
type: string
format: uri
description: >-
The URL to receive video generation task completion updates.
Optional but recommended for production use.
- System will POST task status and results to this URL when
video generation completes
- Callback includes generated video URLs and task
information
- Your callback endpoint should accept POST requests with
JSON payload containing video 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 video generation task
properties:
prompt:
type: string
description: >-
Text prompt describing the desired video motion.
Required field.
- Should be detailed and specific about the desired
visual motion
- Describe movement, action sequences, camera work, and
timing
- Include details about subjects, environments, and
motion dynamics
- Maximum length: 5000 characters
- Supports English language prompts
examples:
- >-
A couple of doors open to the right one by one
randomly and stay open, to show the inside, each is
either a living room, or a kitchen, or a bedroom or an
office, with little people living inside.
aspect_ratio:
type: string
description: >-
Specifies the width-to-height ratio of the generated
video. 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: 2:3
enum:
- '2:3'
- '3:2'
- '1:1'
- '16:9'
- '9:16'
default: '2:3'
examples:
- '2:3'
mode:
type: string
description: >-
Specifies the generation mode affecting the style and
intensity of motion.
- **fun**: More creative and playful interpretation
- **normal**: Balanced approach with good motion quality
- **spicy**: More dynamic and intense motion effects
Default: normal
enum:
- fun
- normal
- spicy
default: normal
examples:
- normal
duration:
type: number
description: >-
The duration of the generated video (in seconds) (6-30).
(Minimum: 6, Maximum: 30, Step: 1)
resolution:
type: string
description: The resolution of the generated video.
enum:
- 480p
- 720p
x-apidog-enum:
- value: 480p
name: ''
description: ''
- value: 720p
name: ''
description: ''
default: 480p
examples:
- 480p
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.
required:
- prompt
x-apidog-orders:
- prompt
- aspect_ratio
- mode
- duration
- resolution
- nsfw_checker
x-apidog-ignore-properties: []
required:
- model
- input
x-apidog-orders:
- model
- callBackUrl
- input
examples:
- model: grok-imagine/text-to-video
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
A couple of doors open to the right one by one randomly
and stay open, to show the inside, each is either a living
room, or a kitchen, or a bedroom or an office, with little
people living inside.
aspect_ratio: '2:3'
mode: normal
x-apidog-ignore-properties: []
example:
model: grok-imagine/text-to-video
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
A couple of doors open to the right one by one randomly and
stay open, to show the inside, each is either a living room,
or a kitchen, or a bedroom or an office, with little people
living inside.
aspect_ratio: '2:3'
mode: normal
duration: '6'
resolution: 480p
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: 281e5b0*********************f39b9
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/Video Models/Grok Imagine
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506395-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: []