openapi: 3.0.0
info:
  title: Flux Kontext API
  description: Apikley Flux Kontext API Documentation - Text-to-Image and Image Editing API
  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/flux/kontext/record-info:
    get:
      summary: Get Image Details
      description: |-
        Query the status and results of an image generation or editing task.

        ### Status Descriptions
        - 0: GENERATING - Task is currently being processed
        - 1: SUCCESS - Task completed successfully
        - 2: CREATE_TASK_FAILED - Failed to create the task
        - 3: GENERATE_FAILED - Task creation succeeded but generation failed

        ### Important Notes
        - Generated images (resultImageUrl) will expire after 14 days
      operationId: get-image-details
      parameters:
        - in: query
          name: taskId
          description: Unique identifier of the image generation task
          required: true
          schema:
            type: string
          example: task12345
      responses:
        '200':
          description: Request successful
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      code:
                        type: integer
                        enum:
                          - 200
                          - 401
                          - 404
                          - 422
                          - 429
                          - 455
                          - 500
                          - 501
                        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

                          - **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 - Image generation task
                          failed
                      msg:
                        type: string
                        description: Error message when code != 200
                        example: success
                  - type: object
                    properties:
                      data:
                        type: object
                        properties:
                          taskId:
                            type: string
                            description: Unique identifier of the image generation task
                            example: task12345
                          paramJson:
                            type: string
                            description: Request parameters in JSON format
                            example: >-
                              {"prompt":"A serene mountain
                              landscape","aspectRatio":"16:9"}
                          completeTime:
                            type: string
                            format: date-time
                            description: Task completion time
                            example: '2024-03-20T10:30:00Z'
                          response:
                            type: object
                            description: Final result
                            properties:
                              originImageUrl:
                                type: string
                                description: Original image URL (valid for 10 minutes)
                                example: https://example.com/original.jpg
                              resultImageUrl:
                                type: string
                                description: Generated image URL on our server
                                example: https://example.com/result.jpg
                          successFlag:
                            type: integer
                            description: Generation status flag
                            enum:
                              - 0
                              - 1
                              - 2
                              - 3
                            example: 1
                          errorCode:
                            type: integer
                            description: >-
                              Error code if task failed


                              - **400**: Your prompt was flagged by Website as
                              violating content policies.

                              - **500**: Internal Error, Please try again later.

                              The security tolerance level is out of range and
                              should be 0-2 or 0-6.

                              - **501**: Image generation task failed
                            enum:
                              - 400
                              - 500
                              - 501
                            example: null
                          errorMessage:
                            type: string
                            description: Error message if task failed
                            example: ''
                          createTime:
                            type: string
                            format: date-time
                            description: Task creation time
                            example: '2024-03-20T10:25:00Z'
              example:
                code: 200
                msg: success
                data:
                  taskId: task12345
                  paramJson: >-
                    {"prompt":"A serene mountain
                    landscape","aspectRatio":"16:9"}
                  completeTime: '2024-03-20T10:30:00Z'
                  response:
                    originImageUrl: https://example.com/original.jpg
                    resultImageUrl: https://example.com/result.jpg
                  successFlag: 1
                  errorCode: null
                  errorMessage: ''
                  createTime: '2024-03-20T10:25:00Z'
        '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