# Bytedance - V1 Lite Image to Video
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Bytedance - V1 Lite Image to Video
deprecated: false
description: >-
Content generation using bytedance/v1-lite-image-to-video
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
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
Explore all available models
Check credits and account usage
operationId: bytedance-v1-lite-image-to-video
tags:
- docs/en/Market/Video Models/Bytedance
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- bytedance/v1-lite-image-to-video
default: bytedance/v1-lite-image-to-video
description: >-
The model name to use for generation. Required field.
- Must be `bytedance/v1-lite-image-to-video` for this
endpoint
examples:
- bytedance/v1-lite-image-to-video
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
- 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 generation task
properties:
prompt:
description: >-
The text prompt used to generate the video (Max length:
10000 characters)
type: string
maxLength: 10000
examples:
- >-
Multiple shots. A traveler crosses an endless desert
toward a glowing archway. [Cut to] His cloak whips in
the wind as he reaches the massive stone threshold.
[Wide shot] He steps through — and vanishes into a
burst of light
image_url:
description: >-
The URL of the image used to generate video (File URL
after upload, not file content; Accepted types:
image/jpeg, image/png, image/webp; Max size: 10.0MB)
type: string
examples:
- >-
https://file.aiquickdraw.com/custom-page/akr/section-images/17550783375205e9woshz.png
resolution:
description: >-
Video resolution - 480p for faster generation, 720p for
higher quality
type: string
enum:
- 480p
- 720p
- 1080p
default: 720p
examples:
- 720p
duration:
description: Duration of the video in seconds
type: string
enum:
- '5'
- '10'
default: '5'
examples:
- '5'
camera_fixed:
description: >-
Whether to fix the camera position (Boolean value
(true/false))
type: boolean
examples:
- false
seed:
description: >-
Random seed to control video generation. Use -1 for
random. (Min: -1, Max: 2147483647, Step: 1) (step: 1)
type: number
minimum: -1
maximum: 2147483647
default: -1
examples:
- -1
enable_safety_checker:
description: >-
The safety checker is always enabled in Playground. It
can only be disabled by setting false through the API.
(Boolean value (true/false))
type: boolean
examples:
- true
end_image_url:
description: >-
The URL of the image the video ends with. Defaults to
None. (File URL after upload, not file content; Accepted
types: image/jpeg, image/png, image/webp; Max size:
10.0MB)
type: string
examples:
- ''
nsfw_checker:
type: boolean
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.
Note: There is no guarantee that everything can be
filtered out; if you are not satisfied with the results,
you will need to make your own arrangements.
required:
- prompt
- image_url
x-apidog-orders:
- prompt
- image_url
- resolution
- duration
- camera_fixed
- seed
- enable_safety_checker
- end_image_url
- 01KWKMSSBV2ZAB19H02W9900M3
x-apidog-refs:
01KWKMSSBV2ZAB19H02W9900M3:
$ref: '#/components/schemas/nsfw_checker'
x-apidog-ignore-properties:
- nsfw_checker
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: bytedance/v1-lite-image-to-video
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Multiple shots. A traveler crosses an endless desert toward a
glowing archway. [Cut to] His cloak whips in the wind as he
reaches the massive stone threshold. [Wide shot] He steps
through — and vanishes into a burst of light
image_url: >-
https://file.aiquickdraw.com/custom-page/akr/section-images/17550783375205e9woshz.png
resolution: 720p
duration: '5'
camera_fixed: false
seed: -1
enable_safety_checker: true
end_image_url: ''
nsfw_checker: false
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_bytedance_1765186743319
headers: {}
x-apidog-name: ''
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
callbacks:
videoTaskCompleted:
'{request.body#/callBackUrl}':
post:
description: >-
The system sends this callback when the
`bytedance/v1-lite-image-to-video` task succeeds or fails.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- code
- msg
- data
properties:
code:
type: integer
description: >-
Unified callback code: 200 for success, 501 for
failure.
enum:
- 200
- 501
msg:
type: string
description: Unified callback message.
enum:
- Playground task completed successfully.
- Playground task failed.
data:
type: object
required:
- taskId
- model
- state
- param
- resultJson
- failCode
- failMsg
properties:
taskId:
type: string
description: The unique task identifier.
model:
type: string
description: The model used for the task.
enum:
- bytedance/v1-lite-image-to-video
state:
type: string
description: Terminal task state.
enum:
- success
- fail
param:
type: string
description: >-
JSON string containing the submitted task
parameters.
resultJson:
type: string
nullable: true
description: >-
JSON string containing resultUrls,
firstFrameUrl, lastFrameUrl, or resultObject
when successful. Null when failed.
failCode:
type: string
nullable: true
description: Null when successful; failure code when failed.
failMsg:
type: string
nullable: true
description: >-
Null when successful; failure message when
failed.
costTime:
type: integer
format: int64
description: >-
Task processing time. Present on successful
callbacks.
completeTime:
type: integer
format: int64
description: Task completion timestamp.
createTime:
type: integer
format: int64
description: Task creation timestamp.
updateTime:
type: integer
format: int64
description: Task update timestamp.
creditsConsumed:
type: number
description: >-
Credits consumed by the task. Present on
successful callbacks.
examples:
success:
summary: Task completed successfully
value:
code: 200
msg: Playground task completed successfully.
data:
taskId: task_example_video_webhook_001
model: bytedance/v1-lite-image-to-video
state: success
param: >-
{"input":"{\"prompt\":\"Multiple shots. A traveler
crosses an endless desert toward a glowing
archway. [Cut to] His cloak whips in the wind
a...\",\"image_url\":\"https://example.com/input-image.jpg\",\"resolution\":\"720p\",\"duration\":\"5\",\"camera_fixed\":false,\"seed\":-1,\"enable_safety_checker\":true,\"end_image_url\":\"https://example.com/input-image.jpg\",\"nsfw_checker\":false}","callBackUrl":"https://example.com/callback","model":"bytedance/v1-lite-image-to-video"}
resultJson: >-
{"resultUrls":["https://example.com/generated-video.mp4"]}
failCode: null
failMsg: null
costTime: 12
completeTime: 1234567890
createTime: 1234560000
updateTime: 1234567890
creditsConsumed: 1.23
failure:
summary: Task failed
value:
code: 501
msg: Playground task failed.
data:
taskId: task_example_video_webhook_001
model: bytedance/v1-lite-image-to-video
state: fail
param: >-
{"input":"{\"prompt\":\"Multiple shots. A traveler
crosses an endless desert toward a glowing
archway. [Cut to] His cloak whips in the wind
a...\",\"image_url\":\"https://example.com/input-image.jpg\",\"resolution\":\"720p\",\"duration\":\"5\",\"camera_fixed\":false,\"seed\":-1,\"enable_safety_checker\":true,\"end_image_url\":\"https://example.com/input-image.jpg\",\"nsfw_checker\":false}","callBackUrl":"https://example.com/callback","model":"bytedance/v1-lite-image-to-video"}
failCode: GENERATION_FAILED
failMsg: The generation task failed.
responses:
'200':
description: Callback received successfully.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
example: 200
msg:
type: string
example: success
example:
code: 200
msg: success
x-apidog-folder: docs/en/Market/Video Models/Bytedance
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506401-run
components:
schemas:
nsfw_checker:
type: object
properties:
nsfw_checker:
type: boolean
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.
Note: There is no guarantee that everything can be filtered out; if
you are not satisfied with the results, you will need to make your
own arrangements.
x-apidog-orders:
- nsfw_checker
x-apidog-ignore-properties: []
x-apidog-folder: ''
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: >-
All API requests require a Bearer Token. Add the header `Authorization:
Bearer YOUR_API_KEY` to authenticate requests.
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
所有 API 请求都需要 Bearer Token。请在请求头中添加 `Authorization: Bearer YOUR_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: []
```