openapi: 3.0.0
info:
  title: Hailuo API
  description: Apikley Hailuo API Documentation - Text to Video
  version: 1.0.0
  contact:
    name: Technical Support
    email: [email protected]
servers:
  - url: https://api.apikley.ru
    description: API Server
security:
  - BearerAuth: []
paths:
  /api/v1/jobs/createTask:
    post:
      summary: Generate videos from text using hailuo/02-text-to-video-pro
      operationId: hailuo-02-text-to-video-pro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
              properties:
                model:
                  type: string
                  enum:
                    - hailuo/02-text-to-video-pro
                  default: hailuo/02-text-to-video-pro
                  description: |-
                    The model name to use for generation. Required field.

                    - Must be `hailuo/02-text-to-video-pro` for this endpoint
                  example: hailuo/02-text-to-video-pro
                callBackUrl:
                  type: string
                  format: uri
                  description: >-
                    The URL to receive generation task completion updates.
                    Optional but recommended for production use.


                    - System will POST task status and results to this URL when
                    generation completes

                    - Callback includes generated content URLs and task
                    information

                    - Your callback endpoint should accept POST requests with
                    JSON payload containing results

                    - Alternatively, use the Get Task Details endpoint to poll
                    task status
                  example: https://your-domain.com/api/callback
                input:
                  type: object
                  description: Input parameters for the generation task
                  properties:
                    prompt:
                      description: >-
                        The text prompt for video generation (Max length: 1500
                        characters)
                      type: string
                      maxLength: 1500
                      example: >-
                        High top angle wide mid close-up tracking shot, flying
                        very fast two meters high over prehistoric ferns and
                        moss-covered ground, dominated by a real young boy (pink
                        t-shirt, pink shorts, white shoes, white long socks),
                        with his back to the camera, body stretched out, gliding
                        smoothly forward, flying in the air, casting a clear
                        shadow on the terrain below. His legs and body are high
                        above the surface, his feet not touching the ground,
                        soaring in a Superman pose. The background is a vast
                        Jurassic valley, filled with dense, ancient jungle
                        vegetation and towering cycads. In the distance, rugged
                        volcanic mountains rise with a winding path cutting
                        through. Massive, slow-moving sauropods graze far off on
                        the horizon. Large, fluffy white clouds float in the
                        vibrant blue sky. Strong dynamic motion blur adds a
                        vivid sense of high-speed flight and deep cinematic
                        perspective. Realistic image –raw.
                    prompt_optimizer:
                      description: >-
                        Whether to use the model's prompt optimizer (Boolean
                        value (true/false))
                      type: boolean
                      example: true
                  required:
                    - prompt
            example:
              model: hailuo/02-text-to-video-pro
              callBackUrl: https://your-domain.com/api/callback
              input:
                prompt: >-
                  High top angle wide mid close-up tracking shot, flying very
                  fast two meters high over prehistoric ferns and moss-covered
                  ground, dominated by a real young boy (pink t-shirt, pink
                  shorts, white shoes, white long socks), with his back to the
                  camera, body stretched out, gliding smoothly forward, flying
                  in the air, casting a clear shadow on the terrain below. His
                  legs and body are high above the surface, his feet not
                  touching the ground, soaring in a Superman pose. The
                  background is a vast Jurassic valley, filled with dense,
                  ancient jungle vegetation and towering cycads. In the
                  distance, rugged volcanic mountains rise with a winding path
                  cutting through. Massive, slow-moving sauropods graze far off
                  on the horizon. Large, fluffy white clouds float in the
                  vibrant blue sky. Strong dynamic motion blur adds a vivid
                  sense of high-speed flight and deep cinematic perspective.
                  Realistic image –raw.
                prompt_optimizer: true
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ApiResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          taskId:
                            type: string
                            description: >-
                              Task ID, can be used with Get Task Details
                              endpoint to query task status
                            example: task_hailuo_1765185319478
              example:
                code: 200
                msg: success
                data:
                  taskId: task_hailuo_1765185319478
        '500':
          $ref: '#/components/responses/Error'
components:
  schemas:
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          enum:
            - 200
            - 401
            - 402
            - 404
            - 422
            - 429
            - 455
            - 500
            - 501
            - 505
          description: >-
            Response status code


            - **200**: Success - Request has been processed successfully

            - **401**: Unauthorized - Authentication credentials are missing or
            invalid

            - **402**: Insufficient Credits - Account does not have enough
            credits to perform the operation

            - **404**: Not Found - The requested resource or endpoint does not
            exist

            - **422**: Validation Error - The request parameters failed
            validation checks

            - **429**: Rate Limited - Request limit has been exceeded for this
            resource

            - **455**: Service Unavailable - System is currently undergoing
            maintenance

            - **500**: Server Error - An unexpected error occurred while
            processing the request

            - **501**: Generation Failed - Content generation task failed

            - **505**: Feature Disabled - The requested feature is currently
            disabled
        msg:
          type: string
          description: Response message, error description when failed
          example: success
  responses:
    Error:
      description: Server Error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        All APIs require authentication via Bearer Token.


        Get API Key:

        1. Visit [API Key Management Page](https://app.apikley.ru/keys) to get your
        API Key


        Usage:

        Add to request header:

        Authorization: Bearer APIKLEY_API_KEY


        Note:

        - Keep your API Key secure and do not share it with others

        - If you suspect your API Key has been compromised, reset it immediately
        in the management page