Rivya AI Docs

Hailuo Pro API Integration

Use Hailuo Pro through Rivya Public API v1 with model id hailuo-pro, supported inputs, parameters, Files API rules, credits, and response examples.

Available via APIText or URL ready; reference modes use Files APIVideo
API model id

hailuo-pro

Inputs

text, file

Files API

Required for reference modes

Base credits

57

Capability

Video

Billing

FIXED

Prompt limit

1500 characters

Request contract

Send the model id at the top level. Model-specific controls belong in params.

KeyTypeRequiredDefaultDescription
modelstringYeshailuo-proUse the hailuo-pro API model id.
promptstringYes-Maximum 1500 characters for this model.
paramsobjectNo-Model-specific parameter object. Use the rows below for allowed keys.
client_request_idstringNo-Optional client-side id for tracing requests in your system.

Model parameters

KeyTypeRequiredDefaultRangeOptionsDescription
prompt_optimizerselectNofalse-false, trueLets Hailuo rewrite and optimize your prompt before generation. Turn it off when you want the run to stay closer to your raw wording.

Upload policy

Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.

Reference rule

Reference images: Image mode accepts up to 2 images, and the second image becomes the last frame.

Max files

2

Accepted file kinds

image

Duration token

Video and audio references should carry durationToken from /api/v1/files when duration verification is required.

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

Minimal request

{
  "model": "hailuo-pro",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "prompt_optimizer": "false"
  }
}

Reference-file request

{
  "model": "hailuo-pro",
  "prompt": "A cinematic product reveal with smooth camera movement",
  "params": {
    "prompt_optimizer": "false",
    "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_pro_example",
  "status": "queued",
  "model": "hailuo-pro",
  "reserved_credits": 57,
  "final_credits": 0,
  "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.