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/lyrics/record-info:
    get:
      summary: Get Lyrics Task Details
      description: >-
        Retrieve detailed information about a lyrics generation task.


        ### Usage Guide

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

        - Retrieve generated lyrics content once the task is complete

        - Track task progress and access any error information if generation
        failed


        ### Status Descriptions

        - `PENDING`: Task is waiting to be processed

        - `SUCCESS`: Lyrics generated successfully

        - `CREATE_TASK_FAILED`: Failed to create the task

        - `GENERATE_LYRICS_FAILED`: Failed during lyrics generation

        - `CALLBACK_EXCEPTION`: Error occurred during callback

        - `SENSITIVE_WORD_ERROR`: Content filtered due to sensitive words


        ### Developer Notes

        - Successful tasks will include multiple lyrics variations

        - Each lyrics set includes both content and a suggested title

        - Error codes and messages are provided for failed tasks
      operationId: get-lyrics-details
      parameters:
        - in: query
          name: taskId
          description: >-
            Unique identifier of the lyrics generation task to retrieve. This is
            the taskId returned when creating the lyrics generation task.
          required: true
          example: 11dc****8b0f
          schema:
            type: string
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      code:
                        type: integer
                        enum:
                          - 200
                          - 400
                          - 401
                          - 404
                          - 422
                          - 451
                          - 455
                          - 500
                        description: >-
                          Response status code


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

                          - **400**: Please try rephrasing   with more specific
                          details or using a different approach.

                          Song Description contained artist name:

                          Song Description flagged for moderation

                          Unable to generate lyrics from song   description

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

                          Internal Error - Please try again later.
                      msg:
                        type: string
                        description: Error message when code != 200
                        example: success
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          taskId:
                            type: string
                            description: Task ID
                          param:
                            type: string
                            description: Parameter information for task generation
                          response:
                            type: object
                            properties:
                              taskId:
                                type: string
                                description: Task ID
                              data:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    text:
                                      type: string
                                      description: Lyrics content
                                    title:
                                      type: string
                                      description: Lyrics title
                                    status:
                                      type: string
                                      description: Generation status
                                      enum:
                                        - complete
                                        - failed
                                    errorMessage:
                                      type: string
                                      description: >-
                                        Error message, valid when status is
                                        failed
                          status:
                            type: string
                            description: Task status
                            enum:
                              - PENDING
                              - SUCCESS
                              - CREATE_TASK_FAILED
                              - GENERATE_LYRICS_FAILED
                              - CALLBACK_EXCEPTION
                              - SENSITIVE_WORD_ERROR
                          type:
                            type: string
                            description: Task type
                            example: LYRICS
                          errorCode:
                            type: number
                            description: >-
                              Error code, valid when task fails


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

                              - **400**: Please try rephrasing   with more
                              specific details or using a different approach.

                              Song Description contained artist name

                              Song Description flagged for moderation

                              Unable to generate lyrics from song   description

                              - **500**: Internal Error - Please try again
                              later.
                            enum:
                              - 200
                              - 400
                              - 500
                          errorMessage:
                            type: string
                            description: Error message, valid when task fails
              example:
                code: 200
                msg: success
                data:
                  taskId: 11dc****8b0f
                  param: '{"prompt":"A song about peaceful night in the city"}'
                  response:
                    taskId: 11dc****8b0f
                    data:
                      - text: |-
                          [Verse]
                          我穿越城市黑暗夜
                          心中燃烧梦想的烈火
                        title: 钢铁侠
                        status: complete
                        errorMessage: ''
                  status: SUCCESS
                  type: LYRICS
                  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