openapi: 3.0.0
info:
  title: Bytedance API
  description: Apikley Bytedance API Documentation - Image to Video
  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 videos from images using bytedance/v1-pro-fast-image-to-video
      operationId: bytedance-v1-pro-fast-image-to-video
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - model
              properties:
                model:
                  type: string
                  enum:
                    - bytedance/v1-pro-fast-image-to-video
                  default: bytedance/v1-pro-fast-image-to-video
                  description: >-
                    The model name to use for generation. Required field.


                    - Must be `bytedance/v1-pro-fast-image-to-video` for this
                    endpoint
                  example: bytedance/v1-pro-fast-image-to-video
                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 generate the video (Max length:
                        10000 characters)
                      type: string
                      maxLength: 10000
                      example: >-
                        A cinematic close-up sequence of a single elegant
                        ceramic coffee cup with saucer on a rustic wooden table
                        near a sunlit window, hot rich espresso poured in a thin
                        golden stream from above, gradually filling the cup in
                        distinct stages: empty with faint steam, 1/4 filled with
                        dark crema, half-filled with swirling coffee and rising
                        steam, 3/4 filled nearing the rim, perfectly full just
                        below overflow with glossy surface and soft bokeh
                        highlights; ultra-realistic, warm golden-hour light,
                        shallow depth of field, photorealism, detailed textures,
                        subtle steam wisps, serene inviting atmosphere --ar 16:9
                        --q 2 --style raw
                    image_url:
                      description: >-
                        The URL of the image used to generate video (File URL
                        after upload, not file content; Accepted types:
                        image/jpeg, image/png, image/webp; Max size: 10.0MB)
                      type: string
                      example: >-
                        https://file.aiquickdraw.com/custom-page/akr/section-images/1762340693669m6sey187.webp
                    resolution:
                      description: >-
                        Video resolution - 480p for faster generation, 720p for
                        balance, 1080p for higher quality
                      type: string
                      enum:
                        - 720p
                        - 1080p
                      default: 720p
                      example: 720p
                    duration:
                      description: Duration of the video in seconds
                      type: string
                      enum:
                        - '5'
                        - '10'
                      default: '5'
                      example: '5'
                  required:
                    - prompt
                    - image_url
            example:
              model: bytedance/v1-pro-fast-image-to-video
              callBackUrl: https://your-domain.com/api/callback
              input:
                prompt: >-
                  A cinematic close-up sequence of a single elegant ceramic
                  coffee cup with saucer on a rustic wooden table near a sunlit
                  window, hot rich espresso poured in a thin golden stream from
                  above, gradually filling the cup in distinct stages: empty
                  with faint steam, 1/4 filled with dark crema, half-filled with
                  swirling coffee and rising steam, 3/4 filled nearing the rim,
                  perfectly full just below overflow with glossy surface and
                  soft bokeh highlights; ultra-realistic, warm golden-hour
                  light, shallow depth of field, photorealism, detailed
                  textures, subtle steam wisps, serene inviting atmosphere --ar
                  16:9 --q 2 --style raw
                image_url: >-
                  https://file.aiquickdraw.com/custom-page/akr/section-images/1762340693669m6sey187.webp
                resolution: 720p
                duration: '5'
      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_1765182752206
              example:
                code: 200
                msg: success
                data:
                  taskId: task_bytedance_1765182752206
        '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