> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convertly.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Start a folder archive job



## OpenAPI

````yaml /openapi.json post /api/files/archive
openapi: 3.1.0
info:
  title: Convertly API
  version: 1.0.0
  description: >-
    Convertly provides production API endpoints for media conversion,
    compression, Image CDN delivery, Forma AI, HLS/DASH video streaming, media
    tools, async jobs, workflows, webhooks, and Convertly Storage.
  license:
    name: Proprietary
    url: https://convertly.sh/terms
servers:
  - url: https://convertly.sh
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /api/files/archive:
    post:
      tags:
        - Files
      summary: Start a folder archive job
      operationId: startFolderArchive
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                folderId:
                  type:
                    - string
                    - 'null'
                  format: uuid
                fileIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                targetFolderId:
                  type:
                    - string
                    - 'null'
                  format: uuid
                format:
                  type: string
                  enum:
                    - zip
                    - tar
                    - tgz
                  default: zip
                recursive:
                  type: boolean
                  default: true
                delivery:
                  type: string
                  enum:
                    - library
                    - download
                  default: library
                downloadName:
                  type: string
      responses:
        '202':
          description: Archive job started
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Dashboard-generated Convertly API key. Keys currently begin with
        `cvly_`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative API key header for server-side clients.

````