Appearance
Grok Imagine - Video Upscale
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Grok Imagine - Video Upscale
deprecated: false
description: >+
## Task ID Source
The `task_id` parameter should be obtained from a previously generated
video task. You can upscale videos that were created using:
**Generate videos First**
Create videos using the text-to-video model to get a task ID for upscaling.
**How to get a task ID:**
1. Use the [Text to video API](/market/grok-imagine/text-to-video) to
generate videos.
2. Extract the `taskId` from the API response.
3. Use that `taskId` as the `task_id` parameter in the upscale request.
::: infoInformation]
Only videos generated by **Kie AI models** can be upscaled. External
videos are not supported.
:::
---
## Query Task Status
After submitting an upscale 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.
::: tipPro Tip]
For production use, we recommend using the `callBackUrl` parameter to
receive automatic notifications when upscaling completes, rather than
polling the status endpoint.
:::
---
## Related Resources
* 📚 [Market Overview](/market/quickstart) - Explore all available
models
* ⚙️ [Common API](/common-api/get-account-credits) - Check credits and
account usage
operationId: grok-imagine-upscale
tags:
- docs/en/Market/Video Models/Grok Imagine
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
model:
type: string
enum:
- grok-imagine/upscale
default: grok-imagine/upscale
description: |-
The model name to use for generation. Required field.
- Must be `grok-imagine/upscale` for this endpoint
examples:
- grok-imagine/upscale
callBackUrl:
type: string
format: uri
description: >-
The URL to receive video upscaling task completion updates.
Optional but recommended for production use.
- System will POST task status and results to this URL when
upscaling completes
- Callback includes generated upscaled 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 upscaling task
properties:
task_id:
type: string
description: >-
Task ID from a previously successful video generation
task. Required field.
- Must be from a Kie AI video generation model (e.g.,
grok-imagine/text-to-video)
- The original video generation must have completed
successfully
- Only Kie AI-generated task IDs are supported
maxLength: 100
examples:
- task_grok_12345678
required:
- task_id
x-apidog-orders:
- task_id
x-apidog-ignore-properties: []
required:
- model
- input
x-apidog-orders:
- model
- callBackUrl
- input
examples:
- model: grok-imagine/upscale
callBackUrl: https://your-domain.com/api/callback
input:
task_id: task_grok_12345678
x-apidog-ignore-properties: []
example:
model: grok-imagine/upscale
callBackUrl: https://your-domain.com/api/callback
input:
task_id: task_grok_12345678
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-28506370-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: []