> ## 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.

# Hailuo 2.3

> Hailuo 2.3 API 可根据文本生成视频，可选用一张首帧引导，支持 768p 下 6 或 10 秒，或 1080p 下 6 秒。

> [!TIP]
>
> 1. 提交后会返回 `task_id`。如果提供了 `callback_url`，当任务状态变为 `finished` 或 `failed` 时，系统会向 `callback_url` 发送 POST 请求。
> 2. 无论是否提供 `callback_url`，都可以通过统一的[查询任务状态](https://docs.poyo.ai/zh/api-manual/task-management/status.md)接口获取结果。

`hailuo-2.3` 支持仅用提示词生成，以及可选的首帧引导生成。

## 模型

* **hailuo-2.3** - 文生视频，可选 `start_image_url`

## 必填参数

* **prompt**：用于视频生成的文本提示词

## 可选参数

* **duration**：`6` 或 `10`。默认为 `6`
* **resolution**：`768p` 或 `1080p`。默认为 `768p`
* **start\_image\_url**：可选的首帧图片
* **prompt\_optimizer**：可选的布尔开关

## 注意事项

* 不支持 `end_image_url`
* `1080p` 仅支持 `duration=6`


## OpenAPI

````yaml zh/api-manual/video-series/hailuo-2-3.json POST /api/generate/submit
openapi: 3.0.0
info:
  title: PoYo AI - Hailuo 2.3 API
  description: Hailuo 2.3 API 可根据文本生成视频，并可选用一张首帧引导，支持 768p 的 6 秒或 10 秒视频，或 1080p 的 6 秒视频。
  version: 1.0.0
servers:
  - url: https://api.poyo.ai
    description: 生产环境
security:
  - BearerAuth: []
paths:
  /api/generate/submit:
    post:
      tags:
        - Hailuo 2.3
      summary: 提交 Hailuo 2.3 任务
      description: 使用 Hailuo 2.3 生成视频
      operationId: submitHailuo23Task
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitRequest'
            examples:
              hailuo-2-3:
                summary: Hailuo 2.3
                value:
                  model: hailuo-2.3
                  callback_url: https://your-domain.com/callback
                  input:
                    prompt: >-
                      a tiktok dancer is dancing on a small drone, doing flips
                      and tricks
                    duration: 6
                    resolution: 768p
                    prompt_optimizer: true
      responses:
        '200':
          description: 任务提交成功
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitResponse'
        '400':
          description: 请求参数无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: 未授权：API Key 无效
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SubmitRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: Hailuo 2.3 模型标识
          enum:
            - hailuo-2.3
        callback_url:
          type: string
          format: uri
          description: 接收结果通知的 Webhook 回调 URL
          example: https://your-domain.com/callback
        input:
          type: object
          required:
            - prompt
          properties:
            prompt:
              type: string
              description: 生成的文本提示词。最大长度为 5,000 个字符。
              maxLength: 5000
              example: >-
                a tiktok dancer is dancing on a small drone, doing flips and
                tricks
            duration:
              type: integer
              description: 输出时长，单位为秒
              enum:
                - 6
                - 10
              default: 6
              example: 6
            resolution:
              type: string
              description: 输出分辨率
              enum:
                - 768p
                - 1080p
              default: 768p
              example: 768p
            start_image_url:
              type: string
              format: uri
              description: 可选的首帧图像 URL
              example: https://example.com/start-image.png
            prompt_optimizer:
              type: boolean
              description: 可选的提示词优化开关
              example: true
    SubmitResponse:
      type: object
      required:
        - code
        - data
      properties:
        code:
          type: integer
          example: 200
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
        data:
          type: object
          required:
            - task_id
            - status
            - created_time
          properties:
            task_id:
              type: string
              example: task-unified-1757165031-uyujaw3d
            status:
              type: string
              enum:
                - not_started
                - running
                - finished
                - failed
              example: not_started
              description: >-
                任务状态。提交后立即返回时始终为
                `not_started`。后续状态请通过[查询任务状态](/zh/api-manual/task-management/status)接口或
                `callback_url` 获取。


                - `not_started`：排队中，等待处理

                - `running`：生成中

                - `finished`：已完成，结果在 `files` 或 `output` 中

                - `failed`：失败，详情见 `error_message`
            created_time:
              type: string
              format: date-time
              example: '2025-11-12T10:30:00'
    ErrorResponse:
      type: object
      required:
        - code
        - error
      properties:
        code:
          type: integer
          example: 400
          enum:
            - 200
            - 400
            - 401
            - 402
            - 403
            - 404
            - 408
            - 429
            - 500
            - 502
            - 503
          description: >-
            业务状态码。`200` 表示成功，其他值都表示请求失败。请务必检查这个字段：部分参数校验错误会以 HTTP 200 返回，响应体里的
            `code` 为 `400`。


            - `200`：成功

            - `400`：请求参数无效

            - `401`：API Key 缺失或无效

            - `402`：积分不足

            - `403`：没有权限

            - `404`：资源不存在

            - `408`：请求超时

            - `429`：请求频率超限

            - `500`：服务器内部错误

            - `502`：上游服务错误

            - `503`：服务暂不可用


            详见[错误码](/zh/api-manual/error-codes)。
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              example: Invalid request parameters
            type:
              type: string
              example: invalid_request_error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        所有 API 接口都需要 Bearer Token 认证。


        创建 API Key：登录 PoYo，进入 **仪表盘 → API
        密钥**（[poyo.ai/zh/dashboard/api-key](https://poyo.ai/zh/dashboard/api-key)），点击创建
        Key。


        在请求头中添加：


        ```

        Authorization: Bearer YOUR_API_KEY

        ```

````

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