Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apixo.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Hailuo 2.3 Fast is an image-to-video model for turning one source image into a short generated video. Use this page when you are ready to call the API after trying the model in the APIXO playground.
CapabilityValue
Model IDhailuo-2-3-fast
Modesstandard-image-to-video, pro-image-to-video
Input typeImage-to-video only
Reference imagesExactly 1 image URL
Standard duration6 or 10 seconds
Pro durationFixed 6 seconds
Output resolutionStandard: 768p; Pro: 1080p
Result typeVideo URL in resultJson.resultUrls

Endpoint and authentication

Base URL:
https://api.apixo.ai/api/v1
MethodEndpointPurpose
POST/generateTask/hailuo-2-3-fastSubmit a generation task
GET/statusTask/hailuo-2-3-fast?taskId={taskId}Poll task status and retrieve results
All requests require your APIXO API key:
Authorization: Bearer YOUR_API_KEY
Submit requests also require:
Content-Type: application/json

Copy-paste async quickstart

This minimal request submits a standard image-to-video task and returns a taskId.
curl -X POST "https://api.apixo.ai/api/v1/generateTask/hailuo-2-3-fast" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "standard-image-to-video",
      "prompt": "animate this character portrait with a gentle cinematic camera move",
      "image_urls": [
        "https://example.com/input.jpg"
      ],
      "duration": 6
    }
  }'
Successful response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678"
  }
}
Save the taskId; you need it to poll for the final result.

Poll for result

curl -X GET "https://api.apixo.ai/api/v1/statusTask/hailuo-2-3-fast?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"
Processing response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "processing",
    "createTime": 1767965610929
  }
}
Success response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://file.apixo.ai/video.mp4\"]}",
    "createTime": 1767965610929,
    "completeTime": 1767965730929,
    "costTime": 120000
  }
}
Failed response:
{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "failed",
    "failCode": "SensitiveContent",
    "failMsg": "Content violates provider policy, please adjust the prompt",
    "createTime": 1767965610929,
    "completeTime": 1767965620132
  }
}
Parse resultJson after state becomes success:
const payload = JSON.parse(data.resultJson);
const videoUrls = payload.resultUrls;

Request body

Standard image-to-video

{
  "request_type": "async",
  "input": {
    "mode": "standard-image-to-video",
    "prompt": "animate this still image with smooth parallax and lighting changes",
    "image_urls": [
      "https://example.com/input.jpg"
    ],
    "duration": 10
  }
}

Pro image-to-video

{
  "request_type": "async",
  "input": {
    "mode": "pro-image-to-video",
    "prompt": "animate this image into a high-energy camera move",
    "image_urls": [
      "https://example.com/input.jpg"
    ]
  }
}

Parameters

request_type
string
default:"async"
required
Result delivery mode. Use async for polling with statusTask, or callback for webhook delivery.
callback_url
string
Required when request_type is callback. Must be a public HTTPS URL that can receive the final task payload. See Webhooks.
input
object
required
Hailuo 2.3 Fast input parameters.
Hailuo 2.3 Fast only supports image-to-video. If you need text-to-video, use a different Hailuo model that explicitly supports that mode.

Response format

Submit task response

POST /generateTask/hailuo-2-3-fast returns a task ID when the task is accepted:
code
integer
API status code. 200 means the task was accepted.
message
string
Human-readable status message.
data.taskId
string
Unique task identifier used with the status endpoint.

Status response fields

taskId
string
Unique task identifier.
state
string
Current task state: processing, success, or failed.
resultJson
string
JSON string containing the generated video URLs. Present when state is success.
failCode
string
Machine-readable failure code. Present when state is failed.
failMsg
string
Human-readable failure message. Present when state is failed.
createTime
integer
Task creation timestamp in Unix milliseconds.
completeTime
integer
Task completion timestamp in Unix milliseconds. Present after completion when available.
costTime
integer
Processing duration in milliseconds. Present after completion when available.

Webhook callback mode

Use callback mode when your backend should receive the final result automatically instead of polling.
curl -X POST "https://api.apixo.ai/api/v1/generateTask/hailuo-2-3-fast" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "callback",
    "callback_url": "https://your-server.com/webhooks/apixo",
    "input": {
      "mode": "pro-image-to-video",
      "prompt": "animate this product photo with a polished studio camera move",
      "image_urls": [
        "https://example.com/input.jpg"
      ]
    }
  }'
See Webhooks for delivery requirements and retry behavior.

Billing

Hailuo 2.3 Fast billing depends on the selected mode. Standard mode is billed by output duration; pro mode is billed per task.
ModeUnitAPIXO priceBillable amount
standard-image-to-videoPer output second$0.032 / secondduration * $0.032
pro-image-to-videoPer task$0.33 / use$0.33
For current route and market comparison pricing, see Pricing.

Latency and polling

Video generation is asynchronous. Actual latency may vary by input image, prompt complexity, current queue load, and storage transfer time.
ModeOutput durationRecommended first pollPoll interval
standard-image-to-video6 or 10 seconds30s after task creation10s
pro-image-to-videoFixed 6 seconds30s after task creation10s
costTime is returned in milliseconds after completion when timing data is available. Keep polling while state is processing.
For production workloads, use callback mode to avoid frequent polling on long-running video tasks.
Rate limits and concurrency can vary by account, API key, and route. If you receive 429, slow down requests and retry with backoff. For account-level details, see System APIs.

Errors and troubleshooting

HTTP errors

CodeMeaningWhat to do
400Invalid request body, missing required field, unsupported mode, invalid duration, or invalid input URLFix the request before retrying
401Missing or invalid API keyCheck the Authorization header
402Insufficient balance or quotaAdd balance or switch account/key
403Key or route cannot access the modelCheck permissions and route strategy
429Rate limit or concurrency limit reachedRetry with exponential backoff
500Server error or unmapped upstream failureRetry with backoff
502Upstream provider errorRetry with backoff
504Upstream timeoutRetry or use callback mode for long-running jobs

Task failure codes

Failure codes are mapped from upstream task errors, so exact values can vary. Common examples include:
Fail codeMeaningWhat to do
PromptInvalidPrompt was invalid or rejectedRewrite the prompt and retry
SensitiveContentPrompt or media violated provider policyChange the prompt or input image
NSFWInput or output was flagged as NSFWUse different content
ProhibitedContentDetectedProhibited content was detectedChange the prompt or input image
ImageFormatIncorrectImage format or upload validation failedUse a public JPG, JPEG, or PNG URL
InvalidImageSizeImage dimensions or size were invalidCheck aspect ratio, short side, and file size
RateLimitedUpstream provider rate limit was reachedRetry with exponential backoff
TimeoutUpstream provider timed outRetry, simplify the prompt, or use callback mode
InsufficientBalanceProvider-side balance or quota was insufficientRetry later or contact support
Unknown errorUpstream failure was not mapped to a known codeRetry with backoff; contact support if it persists

Request checks

  • Send exactly one image_urls item.
  • Use only standard-image-to-video or pro-image-to-video.
  • Include duration only when you need standard mode; pro mode ignores it.
  • Use duration as 6, 10, "6", or "10" for standard mode.
  • Use a public, directly fetchable JPG, JPEG, or PNG image URL.
See Error Codes for the full error reference.