Appearance
Hailuo Pro Image to Video
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: ' Hailuo Pro Image to Video'
deprecated: false
description: >-
Content generation using hailuo/02-image-to-video-pro
## 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: hailuo-02-image-to-video-pro
tags:
- docs/en/Market/Video Models/Hailuo
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- hailuo/02-image-to-video-pro
default: hailuo/02-image-to-video-pro
description: |-
The model name to use for generation. Required field.
- Must be `hailuo/02-image-to-video-pro` for this endpoint
examples:
- hailuo/02-image-to-video-pro
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: >-
Text prompt describing the desired video animation (Max
length: 1500 characters)
type: string
maxLength: 1500
examples:
- >-
Cinematic wide shot: A colossal starship drifts
silently above the rings of Saturn, its metallic hull
reflecting streaks of cosmic light. The camera pushes
closer, revealing thousands of illuminated windows
like a floating city. Smaller fighter crafts dart
across the frame, leaving neon trails as they maneuver
through the vastness of space. A sudden burst of
thrusters scatters asteroid fragments in slow motion,
glowing faintly as they collide and drift apart.
image_url:
description: >-
Input image to animate (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/17585210783150ispzfo7.png
end_image_url:
description: >-
Optional URL of the image to use as the last frame of
the video (File URL after upload, not file content;
Accepted types: image/jpeg, image/png, image/webp; Max
size: 10.0MB)
type: string
examples:
- ''
prompt_optimizer:
description: >-
Whether to use the model's prompt optimizer (Boolean
value (true/false))
type: boolean
examples:
- true
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
- image_url
x-apidog-orders:
- prompt
- image_url
- end_image_url
- prompt_optimizer
- nsfw_checker
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: hailuo/02-image-to-video-pro
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Cinematic wide shot: A colossal starship drifts silently above
the rings of Saturn, its metallic hull reflecting streaks of
cosmic light. The camera pushes closer, revealing thousands of
illuminated windows like a floating city. Smaller fighter
crafts dart across the frame, leaving neon trails as they
maneuver through the vastness of space. A sudden burst of
thrusters scatters asteroid fragments in slow motion, glowing
faintly as they collide and drift apart.
image_url: >-
https://file.aiquickdraw.com/custom-page/akr/section-images/17585210783150ispzfo7.png
end_image_url: ''
prompt_optimizer: true
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_hailuo_1765185328412
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/Hailuo
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506405-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: []