Hailuo 2.3 API Integration
Use Hailuo 2.3 through Rivya Public API v1 with model id hailuo-2-3, supported inputs, parameters, Files API rules, credits, and response examples.
hailuo-2-3
file
Required for reference modes
per_video · standard_768P_6=25 · standard_768P_10=40 · standard_1080P_6=40 · pro_768P_6=40 · pro_768P_10=80 · pro_1080P_6=70 · ⌈total⌉
Video
FIXED
5000 characters
Request contract
Send the model id at the top level. Model-specific controls belong in params.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | hailuo-2-3 | Use the hailuo-2-3 API model id. |
| prompt | string | Yes | - | Maximum 5000 characters for this model. |
| params | object | No | - | Model-specific parameter object. Use the rows below for allowed keys. |
| client_request_id | string | No | - | Optional client-side id for tracing requests in your system. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| quality | select | No | standard | - | standard, pro | Quality tier |
| resolution | select | No | 768P | - | 768P, 1080P | Resolution |
| duration | select | No | 6 | - | 6, 10 | Duration |
| nsfw_checker | select | No | true | - | false, true | Content filter |
Upload policy
Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.
Reference image: Upload up to 1 image file for image projects. JPG / PNG / WebP · ≤ 10 MB · 1 image.
1
image
Video and audio references should carry durationToken from /api/v1/files when duration verification is required.
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Minimal request
{
"model": "hailuo-2-3",
"params": {
"quality": "standard",
"resolution": "768P",
"duration": "6",
"nsfw_checker": "true"
}
}Reference-file request
{
"model": "hailuo-2-3",
"params": {
"quality": "standard",
"resolution": "768P",
"duration": "6",
"nsfw_checker": "true",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Create response
The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.
{
"id": "task_hailuo_2_3_example",
"status": "queued",
"model": "hailuo-2-3",
"reserved_credits": 25,
"final_credits": 0,
"settlement_status": "RESERVED",
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Some modes require Files API reference uploads.
