> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poyo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Video Upscaler

> Increase the resolution of an existing video by a scale factor from 1 to 8.

> [!TIP]
>
> 1. After submission, a `task_id` will be returned. If you provided a `callback_url`, when the task status becomes `finished` or `failed`, a POST request will be sent to the `callback_url`.
> 2. Regardless of whether `callback_url` is provided, you can retrieve the response result through the unified [Query Task Status](https://docs.poyo.ai/api-manual/task-management/status.md) endpoint.

Video Upscaler increases the resolution of an existing video. The output size is the input size multiplied by `scale`.

## Models

* **poyo-ai/video-upscaler** — Upscale one video

## Required parameters

* `video_url` (string): Source video URL.

## Optional parameters

* `scale` (number): Upscale factor from `1` to `8`. Default is `2`. Decimals are allowed.

## Output

A finished task returns one upscaled video in `files` with `file_type: video`.

## Examples

* **Upscale a video 2x** — sets `video_url`, `scale`.

## Notes

* PoYo reads the source width, height, duration, and frame rate before submitting. Submission fails if the file has no readable video stream.


## OpenAPI

````yaml api-manual/tools-series/video-upscaler.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: Video Upscaler
  description: Increase the resolution of an existing video.
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      summary: Submit a video upscaling task
      operationId: submit_video_upscaler
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              basic:
                summary: Upscale a video 2x
                value:
                  model: poyo-ai/video-upscaler
                  input:
                    video_url: https://example.com/clip.mp4
                    scale: 2
      responses:
        '200':
          description: Task submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      additionalProperties: false
      required:
        - model
        - input
      properties:
        model:
          type: string
          enum:
            - poyo-ai/video-upscaler
          description: Public model identifier.
        callback_url:
          type: string
          format: uri
          description: Optional webhook URL for task completion or failure notifications.
        input:
          type: object
          additionalProperties: false
          required:
            - video_url
          properties:
            video_url:
              type: string
              format: uri
              description: >-
                Source video URL. Must be a publicly accessible HTTP or HTTPS
                URL.
            scale:
              type: number
              minimum: 1
              maximum: 8
              default: 2
              description: >-
                Upscale factor. The output width and height are the input width
                and height multiplied by this value. Decimals are allowed.
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1793176000-example
            status:
              type: string
              enum:
                - not_started
              example: not_started
            created_time:
              type: string
              format: date-time
              example: '2026-10-28T10:30:00'
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
            type:
              type: string
              example: validation_error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.