Appearance
Wan 2.5 - Text to Video
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Wan 2.5 - Text to Video
deprecated: false
description: >
Video generation by wan/2-5-text-to-video
## Create Task
Use this endpoint to create a new text-to-video 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: wan-2-5-text-to-video
tags:
- docs/en/Market/Video Models/Wan
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- wan/2-5-text-to-video
default: wan/2-5-text-to-video
description: |-
The model name used for generation. This field is required.
- This endpoint must use the `wan/2-5-text-to-video` model
examples:
- wan/2-5-text-to-video
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 text-to-video task.
required:
- prompt
- duration
properties:
prompt:
type: string
maxLength: 800
description: >-
The text prompt for video generation. Supports Chinese
and English. Maximum length: 800 characters.
examples:
- >-
A dimly lit jazz bar at night, wooden tables glowing
under warm pendant lights. Patrons sip drinks and chat
quietly while a three-piece band performs on stage.
The saxophone player stands under a spotlight,
gleaming instrument reflecting the light. No dialogue.
Ambient audio: smooth live jazz music with saxophone
and piano, clinking glasses, low murmur of audience
conversations, occasional burst of laughter from a
nearby table. Camera: slow pan across the crowd, then
gentle zoom toward the saxophone player's solo,
focusing on expressive hand movements.
duration:
type: string
enum:
- '5'
- '10'
description: |-
The duration of the generated video in seconds.
- `5`: 5 seconds
- `10`: 10 seconds
examples:
- '5'
aspect_ratio:
type: string
enum:
- '16:9'
- '9:16'
- '1:1'
description: |-
The aspect ratio of the generated video.
- `16:9`: Landscape
- `9:16`: Portrait
- `1:1`: Square
examples:
- '16:9'
resolution:
type: string
enum:
- 720p
- 1080p
description: |-
Video resolution tier.
- `720p`: 720p
- `1080p`: 1080p
examples:
- 1080p
negative_prompt:
type: string
maxLength: 500
description: >-
Negative prompt used to describe content to avoid.
Maximum length: 500 characters.
enable_prompt_expansion:
type: boolean
description: >-
Whether to enable prompt rewriting using LLM. Improves
results for short prompts but increases processing time.
- Boolean value: `true` / `false`
examples:
- true
seed:
type: integer
description: >-
Random seed for reproducibility. If omitted, a random
seed is chosen.
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.
x-apidog-orders:
- prompt
- duration
- aspect_ratio
- resolution
- negative_prompt
- enable_prompt_expansion
- seed
- nsfw_checker
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: wan/2-5-text-to-video
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
A dimly lit jazz bar at night, wooden tables glowing under
warm pendant lights. Patrons sip drinks and chat quietly while
a three-piece band performs on stage. The saxophone player
stands under a spotlight, gleaming instrument reflecting the
light. No dialogue. Ambient audio: smooth live jazz music with
saxophone and piano, clinking glasses, low murmur of audience
conversations, occasional burst of laughter from a nearby
table. Camera: slow pan across the crowd, then gentle zoom
toward the saxophone player's solo, focusing on expressive
hand movements.
duration: '5'
aspect_ratio: '16:9'
resolution: 1080p
negative_prompt: blurry, flicker, low quality, distorted people, camera shake
enable_prompt_expansion: true
seed: 123456
nsfw_checker: false
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_wan_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_wan_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/Video Models/Wan
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-31160822-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: []