# Hailuo 2.3 Standard 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 2.3 Standard Image to Video
deprecated: false
description: >-
Content generation using hailuo/2-3-image-to-video-standard
## 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: hailuo-2-3-image-to-video-standard
tags:
- docs/en/Market/Video Models/Hailuo
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- hailuo/2-3-image-to-video-standard
default: hailuo/2-3-image-to-video-standard
description: >-
The model name to use for generation. Required field.
- Must be `hailuo/2-3-image-to-video-standard` for this
endpoint
examples:
- hailuo/2-3-image-to-video-standard
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: 5000 characters)
type: string
maxLength: 5000
examples:
- >-
Two armored medieval knights clash in an intense duel
at sunset, cinematic lighting. Metal armor reflects
warm golden light from the sun and the glowing swords.
Sparks explode as the swords collide. Dynamic camera
movement, shallow depth of field, dramatic slow
motion. The scene takes place in an open desert
battlefield, dust in the air, warm orange sun behind
them, epic atmosphere. Highly detailed armor
textures, realistic reflections, volumetric lighting,
cinematic quality.
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/1761736401898mpm67du5.webp
duration:
description: >-
The duration of the video in seconds. 10 seconds videos
are not supported for 1080p resolution.
type: string
enum:
- '6'
- '10'
default: '6'
examples:
- '6'
resolution:
description: The resolution of the generated video.
type: string
enum:
- 768P
- 1080P
default: 768P
examples:
- 768P
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
- duration
- resolution
- 01KWKMVP66ZSBMN3KQ1FMNXN3Y
x-apidog-refs:
01KWKMVP66ZSBMN3KQ1FMNXN3Y:
$ref: '#/components/schemas/nsfw_checker'
x-apidog-ignore-properties:
- nsfw_checker
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: hailuo/2-3-image-to-video-standard
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Two armored medieval knights clash in an intense duel at
sunset, cinematic lighting. Metal armor reflects warm golden
light from the sun and the glowing swords. Sparks explode as
the swords collide. Dynamic camera movement, shallow depth of
field, dramatic slow motion. The scene takes place in an open
desert battlefield, dust in the air, warm orange sun behind
them, epic atmosphere. Highly detailed armor textures,
realistic reflections, volumetric lighting, cinematic quality.
image_url: >-
https://file.aiquickdraw.com/custom-page/akr/section-images/1761736401898mpm67du5.webp
duration: '6'
resolution: 768P
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_hailuo_1765182986510
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
`hailuo/2-3-image-to-video-standard` 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:
- hailuo/2-3-image-to-video-standard
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: hailuo/2-3-image-to-video-standard
state: success
param: >-
{"input":"{\"prompt\":\"Two armored medieval
knights clash in an intense duel at sunset,
cinematic lighting. Metal armor reflects warm
golde...\",\"image_url\":\"https://example.com/input-image.jpg\",\"duration\":\"6\",\"resolution\":\"768P\"}","callBackUrl":"https://example.com/callback","model":"hailuo/2-3-image-to-video-standard"}
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: hailuo/2-3-image-to-video-standard
state: fail
param: >-
{"input":"{\"prompt\":\"Two armored medieval
knights clash in an intense duel at sunset,
cinematic lighting. Metal armor reflects warm
golde...\",\"image_url\":\"https://example.com/input-image.jpg\",\"duration\":\"6\",\"resolution\":\"768P\"}","callBackUrl":"https://example.com/callback","model":"hailuo/2-3-image-to-video-standard"}
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/Hailuo
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-28506404-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: []
```