Video Upscaler API

Overview

Video Upscaler is an asynchronous video-to-video API for enhancing one source video to a higher target resolution. Billing is based on target resolution and billable video duration.

Capability	Value
Model ID	`video-upscaler`
Mode	`video-to-video`
Input videos	Exactly 1 public video URL
Public billable resolution tiers	`1080p`, `2k`, `4k`
Minimum billable duration	5 seconds
Billing	Per second, by output resolution

Endpoint and authentication

Base URL:

https://api.apixo.ai/api/v1

Method	Endpoint	Purpose
`POST`	`/generateTask/video-upscaler`	Submit a video upscaling task
`GET`	`/statusTask/video-upscaler?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

curl -X POST "https://api.apixo.ai/api/v1/generateTask/video-upscaler" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "request_type": "async",
    "input": {
      "mode": "video-to-video",
      "video_urls": [
        "https://example.com/input.mp4"
      ],
      "resolution": "2k"
    }
  }'

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/video-upscaler?taskId=task_12345678" \
  -H "Authorization: Bearer YOUR_API_KEY"

Success response:

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "task_12345678",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://file.apixo.ai/upscaled-video.mp4\"]}",
    "createTime": 1767965610929,
    "completeTime": 1767965652317,
    "costTime": 41388
  }
}

Parse resultJson after state becomes success:

const payload = JSON.parse(data.resultJson);
const videoUrls = payload.resultUrls;

Request body

{
  "request_type": "async",
  "callback_url": "https://your-server.com/webhooks/apixo",
  "input": {
    "mode": "video-to-video",
    "video_urls": [
      "https://example.com/input.mp4"
    ],
    "resolution": "4k"
  }
}

Parameters

string

default:"async"

required

Result delivery mode. Use async for polling with statusTask, or callback for webhook delivery.

string

Required when request_type is callback. Must be a callback URL that can receive the final task payload. See Webhooks.

object

required

Video Upscaler input parameters.

Show properties

string

default:"video-to-video"

Upscaling mode. The only supported public value is video-to-video. If omitted, the backend defaults to video-to-video.

string[]

required

Source video URLs. Must contain exactly 1 non-empty public video URL.

string

default:"1080p"

Target resolution tier. Public billable values: 1080p, 2k, 4k. Values are case-insensitive and normalized to lowercase.

Response format

Submit task response

POST /generateTask/video-upscaler returns a task ID when the task is accepted:

integer

API status code. 200 means the task was accepted.

string

Human-readable status message.

string

Unique task identifier used with the status endpoint.

Status response fields

string

Unique task identifier.

string

Current task state: pending, processing, success, or failed.

string

JSON string containing the upscaled video URL in resultUrls. Present when state is success.

string

Machine-readable failure code. Present when state is failed.

string

Human-readable failure message. Present when state is failed.

integer

Task creation timestamp in Unix milliseconds.

integer

Task completion timestamp in Unix milliseconds. Present after completion.

integer

Processing duration in milliseconds 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/video-upscaler" \
  -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": "video-to-video",
      "video_urls": [
        "https://example.com/input.mp4"
      ],
      "resolution": "1080p"
    }
  }'

See Webhooks for delivery requirements and retry behavior.

Billing

Video Upscaler is billed per billable second. The billable duration is max(5 seconds, actual input video duration).

Resolution	APIXO price
`1080p`	`$0.005 / second`
`2k`	`$0.010 / second`
`4k`	`$0.020 / second`

Billing behavior:

billable_seconds = max(5, actual_video_seconds)
precharge = billable_seconds * unit_price_for_resolution

For current route and market comparison pricing, see Pricing.

Latency and polling

Video Upscaler tasks are asynchronous. Actual latency varies by source video duration, file download speed, target resolution, and queue load.

Use case	Recommended first poll	Poll interval
Short video	30s after task creation	10s-20s
Longer or higher-resolution video	Prefer callback mode	If polling, use 20s or longer

For production queues or longer videos, use callback mode to avoid frequent polling.

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

Code	Meaning	What to do
`400`	Invalid request body, mode, video URL shape, or resolution	Fix the request before retrying
`401`	Missing or invalid API key	Check the `Authorization` header
`402`	Insufficient balance or quota	Add balance or switch account/key
`403`	Key or route cannot access the model	Check permissions and route strategy
`404`	Task not found	Verify the `taskId` and model ID
`429`	Rate limit or concurrency limit reached	Retry with exponential backoff
`500`	Server or unmapped model error	Retry with backoff
`502`	Model service error	Retry with backoff
`504`	Model service timeout	Retry or use callback mode for long-running jobs

Request validation

Condition	Backend behavior
Missing `input`	Returns `The required parameter {{input}} is missing.`
Invalid `mode`	Returns `Invalid mode type. Supported: video-to-video`
Missing `video_urls`	Returns `The required parameter {{video_urls}} is missing.`
`video_urls` is not an array	Returns `The parameter {{video_urls}} must be Array type.`
`video_urls` length is not 1	Returns `The parameter {{video_urls}} must contain exactly 1 video.`
`video_urls[0]` is not a string	Returns `The parameter {{video_urls}} Array elements must be String type.`
`video_urls[0]` is empty	Returns `The parameter {{video_urls}} cannot contain empty string.`
Invalid public `resolution`	Use one of the public billable tiers: `1080p`, `2k`, `4k`.

See Error Codes for the full error reference.

​Overview

​Endpoint and authentication

​Copy-paste async quickstart

​Poll for result

​Request body

​Parameters

​Response format

​Submit task response

​Status response fields

​Webhook callback mode

​Billing

​Latency and polling

​Errors and troubleshooting

​HTTP errors

​Request validation

​Related links

Overview

Endpoint and authentication

Copy-paste async quickstart

Poll for result

Request body

Parameters

Response format

Submit task response

Status response fields

Webhook callback mode

Billing

Latency and polling

Errors and troubleshooting

HTTP errors

Request validation

Related links