openapi: 3.0.0
info:
  title: Bytedance API
  description: 'Apikley Bytedance 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/jobs/createTask:
    post:
      summary: Generate content using bytedance/seedream-v4-edit
      operationId: bytedance-seedream-v4-edit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
              properties:
                model:
                  type: string
                  enum:
                    - bytedance/seedream-v4-edit
                  default: bytedance/seedream-v4-edit
                  description: |-
                    The model name to use for generation. Required field.

                    - Must be `bytedance/seedream-v4-edit` for this endpoint
                  example: bytedance/seedream-v4-edit
                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: >-
                        The text prompt used to edit the image (Max length: 5000
                        characters)
                      type: string
                      maxLength: 5000
                      example: >-
                        Refer to this logo and create a single visual showcase
                        for an outdoor sports brand named ‘APIKLEY’. Display five
                        branded items together in one image: a packaging bag, a
                        hat, a carton box, a wristband, and a lanyard. Use blue
                        as the main visual color, with a fun, simple, and modern
                        style.
                    image_urls:
                      description: >-
                        List of URLs of input images for editing. Presently, up
                        to 10 image inputs are allowed. (File URL after upload,
                        not file content; Accepted types: image/jpeg, image/png,
                        image/webp; Max size: 10.0MB)
                      type: array
                      items:
                        type: string
                        format: uri
                      maxItems: 10
                      example:
                        - >-
                          https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png
                    image_size:
                      description: 'The size of the generated image. '
                      type: string
                      enum:
                        - square
                        - square_hd
                        - portrait_4_3
                        - portrait_3_2
                        - portrait_16_9
                        - landscape_4_3
                        - landscape_3_2
                        - landscape_16_9
                        - landscape_21_9
                      default: square_hd
                      example: square_hd
                    image_resolution:
                      description: >-
                        Final image resolution is determined by combining
                        image_size (aspect ratio) and image_resolution (pixel
                        scale). For example, choosing 4:3 + 4K gives 4096 ×
                        3072px
                      type: string
                      enum:
                        - 1K
                        - 2K
                        - 4K
                      default: 1K
                      example: 1K
                    max_images:
                      description: >-
                        Set this value (1–6) to cap how many images a single
                        generation run can produce in one set—because they’re
                        created in one shot rather than separate requests, you
                        must also state the exact number you want in the prompt
                        so both settings align. (Min: 1, Max: 6, Step: 1) (step:
                        1)
                      type: number
                      minimum: 1
                      maximum: 6
                      default: 1
                      example: 1
                    seed:
                      description: >-
                        Random seed to control the stochasticity of image
                        generation.
                      type: integer
                  required:
                    - prompt
                    - image_urls
            example:
              model: bytedance/seedream-v4-edit
              callBackUrl: https://your-domain.com/api/callback
              input:
                prompt: >-
                  Refer to this logo and create a single visual showcase for an
                  outdoor sports brand named ‘APIKLEY’. Display five branded
                  items together in one image: a packaging bag, a hat, a carton
                  box, a wristband, and a lanyard. Use blue as the main visual
                  color, with a fun, simple, and modern style.
                image_urls:
                  - >-
                    https://file.aiquickdraw.com/custom-page/akr/section-images/1757930552966e7f2on7s.png
                image_size: square_hd
                image_resolution: 1K
                max_images: 1
      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_bytedance_1765176680149
              example:
                code: 200
                msg: success
                data:
                  taskId: task_bytedance_1765176680149
        '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