openapi: 3.0.0
info:
  title: Suno API
  description: Apikley Suno API Documentation
  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/mp4/record-info:
    get:
      summary: Get Music Video Details
      description: >-
        Retrieve detailed information about a music video generation task.


        ### Usage Guide

        - Use this endpoint to check the status of a video generation task

        - Access the video URL once generation is complete

        - Track processing progress and any errors that may have occurred


        ### Status Descriptions

        - `PENDING`: Task is waiting to be processed

        - `SUCCESS`: Video generation completed successfully

        - `CREATE_TASK_FAILED`: Failed to create the video generation task

        - `GENERATE_MP4_FAILED`: Failed during video file creation


        ### Developer Notes

        - The video URL is only available in the response when status is
        `SUCCESS`

        - Error codes and messages are provided for failed tasks

        - Videos are retained for 14 days after successful generation
      operationId: get-music-video-details
      parameters:
        - in: query
          name: taskId
          description: >-
            Unique identifier of the music video generation task to retrieve.
            This is the taskId returned when creating the music video generation
            task.
          required: true
          example: taskId_774b9aa0422f
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      code:
                        type: integer
                        enum:
                          - 200
                          - 400
                          - 401
                          - 402
                          - 404
                          - 409
                          - 422
                          - 429
                          - 455
                          - 500
                        description: >-
                          Response status code


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

                          - **400**: Format Error - The parameter is not in a
                          valid JSON format

                          - **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

                          - **409**: Conflict - WAV record already exists

                          - **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
                      msg:
                        type: string
                        description: Error message when code != 200
                        example: success
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    description: Status code
                    example: 0
                  msg:
                    type: string
                    description: Status message
                    example: ''
                  data:
                    type: object
                    properties:
                      taskId:
                        type: string
                        description: Task ID
                        example: ''
                      musicId:
                        type: string
                        description: Music ID
                        example: ''
                      callbackUrl:
                        type: string
                        description: Callback URL
                        example: ''
                      audioId:
                        type: integer
                        format: int32
                        description: Audio ID
                        example: 0
                      completeTime:
                        type: string
                        format: date-time
                        description: Completion callback time
                        example: ''
                      response:
                        type: object
                        description: Completion callback result
                        properties:
                          videoUrl:
                            type: string
                            description: Video URL
                            example: ''
                      successFlag:
                        type: string
                        description: >-
                          PENDING-Waiting for execution SUCCESS-Success
                          CREATE_TASK_FAILED-Failed to create task
                          GENERATE_MP4_FAILED-Failed to generate MP4
                        example: ''
                      createTime:
                        type: string
                        format: date-time
                        description: Creation time
                        example: ''
                      errorCode:
                        type: integer
                        format: int32
                        description: >-
                          Error code


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

                          - **500**: Internal Error - Please try again later.
                        example: 0
                        enum:
                          - 200
                          - 500
                      errorMessage:
                        type: string
                        description: Error message
                        example: ''
              example:
                code: 0
                msg: ''
                data:
                  taskId: ''
                  musicId: ''
                  callbackUrl: ''
                  audioId: ''
                  completeTime: ''
                  response:
                    videoUrl: ''
                  successFlag: ''
                  createTime: ''
                  errorCode: 0
                  errorMessage: ''
        '500':
          $ref: '#/components/responses/Error'
components:
  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