↓
Rivya AI Docs
Model API guides

Hailuo 2.3 API reference

Check Hailuo 2.3 availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: hailuo-2-3.

Available via APIAPI statusVideo
API model ID

hailuo-2-3

Inputs

file

Files API

Required for reference modes

Credit pricing

Credit rate: 25–80 per video The final cost is rounded up to whole credits.

Capability

Video

Billing

FIXED

Prompt limit

5000 characters

Request fields

Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.

KeyTypeRequiredDefaultDescription
modelstringYeshailuo-2-3Set model to hailuo-2-3.
promptstringYes-Maximum 5000 characters for this model.
paramsobjectYes-The model-specific params object. Use the documented keys and reference-file format for this model.
client_request_idstringNo-Optional ID for tracing this request in your system. It does not replace Idempotency-Key.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
qualityselectNostandard-standard, proQuality tier
resolutionselectNo768P-768P, 1080PResolution
durationselectNo6-6, 10Duration
nsfw_checkerselectNotrue-false, trueContent filter

Upload policy

Upload reference files through Files API first. Keep the original URLs, verified metadata, and tokens. Follow this model's request example: some models use params.referenceMediaItems, while others use different fields.

Reference rule

Reference image: Sign in to upload 1 image for your video. JPG / PNG / WebP · up to 10 MiB (10,485,760 bytes).

Max files

1

Accepted file kinds

image

Duration token

When duration verification is required, use duration_token from /api/v1/files as durationToken in the request. Keep any additional signed metadata this model requires.

kindMax sizeMIME types
image10 MBimage/jpeg, image/png, image/webp

No runnable Public API example is shown for this model.

Reference-file request

{
  "model": "hailuo-2-3",
  "prompt": "A camera slowly circles a product bottle on a studio table.",
  "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",
        "width": 1024,
        "height": 1024,
        "sizeBytes": 1048576,
        "imageDimensionsToken": "image_dimensions_token_from_original_files_api_upload_response"
      }
    ]
  }
}

Example response

An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.

{
  "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.