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/wav/record-info:
    get:
      summary: Get WAV Conversion Details
      description: >-
        Retrieve detailed information about a WAV format conversion task.


        ### Usage Guide

        - Use this endpoint to check the status of a WAV conversion task

        - Access the WAV file URL once conversion is complete

        - Track conversion progress and any errors that may have occurred


        ### Status Descriptions

        - `PENDING`: Task is waiting to be processed

        - `SUCCESS`: WAV conversion completed successfully

        - `CREATE_TASK_FAILED`: Failed to create the conversion task

        - `GENERATE_WAV_FAILED`: Failed during WAV file generation

        - `CALLBACK_EXCEPTION`: Error occurred during callback


        ### Developer Notes

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

        - Error codes and messages are provided for failed tasks

        - WAV files are retained for 14 days after successful conversion
      operationId: get-wav-details
      parameters:
        - in: query
          name: taskId
          description: >-
            Unique identifier of the WAV conversion task to retrieve. This is
            the taskId returned when creating the WAV conversion task.
          required: true
          example: 988e****c8d3
          schema:
            type: string
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      code:
                        type: integer
                        enum:
                          - 200
                          - 401
                          - 404
                          - 422
                          - 451
                          - 455
                          - 500
                        description: >-
                          Response status code


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

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

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

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

                          - **451**: Failed to fetch the image. Kindly verify
                          any access limits set by you or your service provider.

                          - **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:
                      data:
                        type: object
                        properties:
                          taskId:
                            type: string
                            description: Task ID
                          musicId:
                            type: string
                            description: Music ID
                          callbackUrl:
                            type: string
                            description: Callback address
                          musicIndex:
                            type: integer
                            description: Music index
                          completeTime:
                            type: string
                            description: Complete callback time
                            format: date-time
                          response:
                            type: object
                            properties:
                              audioWavUrl:
                                type: string
                                description: WAV format audio file URL
                          successFlag:
                            type: string
                            description: Task status
                            enum:
                              - PENDING
                              - SUCCESS
                              - CREATE_TASK_FAILED
                              - GENERATE_WAV_FAILED
                              - CALLBACK_EXCEPTION
                          createTime:
                            type: string
                            description: Creation time
                            format: date-time
                          errorCode:
                            type: number
                            description: >-
                              Error code, valid when task fails


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

                              - **500**: Internal Error - Please try again
                              later.
                            enum:
                              - 200
                              - 500
                          errorMessage:
                            type: string
                            description: Error message, valid when task fails
              example:
                code: 200
                msg: success
                data:
                  taskId: 988e****c8d3
                  musicId: e231****-****-****-****-****8cadc7dc
                  callbackUrl: https://api.example.com/callback
                  audioId: e231****-****-****-****-****8cadc7dc
                  completeTime: '2025-01-01 00:10:00'
                  response:
                    audioWavUrl: https://example.com/s/04e6****e727.wav
                  successFlag: >-
                    PENDING-待执行 SUCCESS-成功 CREATE_TASK_FAILED-创建任务失败
                    GENERATE_AUDIO_FAILED-生成wav失败
                  createTime: '2025-01-01 00:00:00'
                  errorCode: null
                  errorMessage: null
        '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