openapi: 3.0.0
info:
  title: Hailuo API
  description: Apikley Hailuo API Documentation - Image 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 images using hailuo/2-3-image-to-video-standard
      operationId: hailuo-2-3-image-to-video-standard
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
              properties:
                model:
                  type: string
                  enum:
                    - hailuo/2-3-image-to-video-standard
                  default: hailuo/2-3-image-to-video-standard
                  description: >-
                    The model name to use for generation. Required field.


                    - Must be `hailuo/2-3-image-to-video-standard` for this
                    endpoint
                  example: hailuo/2-3-image-to-video-standard
                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: >-
                        Text prompt describing the desired video animation (Max
                        length: 5000 characters)
                      type: string
                      maxLength: 5000
                      example: >-
                        Two armored medieval knights clash in an intense duel at
                        sunset, cinematic lighting.  Metal armor reflects warm
                        golden light from the sun and the glowing swords. Sparks
                        explode as the swords collide. Dynamic camera movement,
                        shallow depth of field, dramatic slow motion. The scene
                        takes place in an open desert battlefield, dust in the
                        air, warm orange sun behind them, epic atmosphere. 
                        Highly detailed armor textures, realistic reflections,
                        volumetric lighting, cinematic quality.
                    image_url:
                      description: >-
                        Input image to animate (File URL after upload, not file
                        content; Accepted types: image/jpeg, image/png,
                        image/webp; Max size: 10.0MB)
                      type: string
                      example: >-
                        https://file.aiquickdraw.com/custom-page/akr/section-images/1761736401898mpm67du5.webp
                    duration:
                      description: >-
                        The duration of the video in seconds. 10 seconds videos
                        are not supported for 1080p resolution.
                      type: string
                      enum:
                        - '6'
                        - '10'
                      default: '6'
                      example: '6'
                    resolution:
                      description: The resolution of the generated video.
                      type: string
                      enum:
                        - 768P
                        - 1080P
                      default: 768P
                      example: 768P
                  required:
                    - prompt
                    - image_url
            example:
              model: hailuo/2-3-image-to-video-standard
              callBackUrl: https://your-domain.com/api/callback
              input:
                prompt: >-
                  Two armored medieval knights clash in an intense duel at
                  sunset, cinematic lighting.  Metal armor reflects warm golden
                  light from the sun and the glowing swords. Sparks explode as
                  the swords collide. Dynamic camera movement, shallow depth of
                  field, dramatic slow motion. The scene takes place in an open
                  desert battlefield, dust in the air, warm orange sun behind
                  them, epic atmosphere.  Highly detailed armor textures,
                  realistic reflections, volumetric lighting, cinematic quality.
                image_url: >-
                  https://file.aiquickdraw.com/custom-page/akr/section-images/1761736401898mpm67du5.webp
                duration: '6'
                resolution: 768P
      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_1765182986510
              example:
                code: 200
                msg: success
                data:
                  taskId: task_hailuo_1765182986510
        '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