> ## 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.

# Compress files



## OpenAPI

````yaml /openapi.json post /api/compress
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/compress:
    post:
      tags:
        - Media
      summary: Compress files
      operationId: compressFiles
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CompressRequest'
      responses:
        '200':
          description: Compressed files
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessedFilesResponse'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '415':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
        '500':
          $ref: '#/components/responses/Error'
components:
  schemas:
    CompressRequest:
      type: object
      properties:
        files:
          type: array
          items:
            type: string
            format: binary
        mode:
          type: string
          enum:
            - quality
            - target-size
          default: quality
        modes:
          type: string
          description: JSON array of compression modes.
        quality:
          type: integer
          minimum: 1
          maximum: 100
          default: 82
        qualities:
          type: string
          description: JSON array of quality values.
        targetBytes:
          type: integer
          minimum: 1
        targetByteValues:
          type: string
          description: JSON array of target byte values or null.
        lossless:
          type: string
          enum:
            - 'true'
            - 'false'
          default: 'false'
        losslessValues:
          type: string
          description: JSON array of booleans.
        stripMetadata:
          type: string
          enum:
            - 'true'
            - 'false'
          default: 'true'
        stripMetadataValues:
          type: string
          description: JSON array of booleans.
        saveToStorage:
          type: string
          enum:
            - 'true'
            - 'false'
          default: 'false'
          description: >-
            API-key requests do not save files by default. Set true to store
            uploads and outputs in Convertly storage.
      required:
        - files
    ProcessedFilesResponse:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/ProcessedFile'
        storage:
          $ref: '#/components/schemas/StorageStatus'
      required:
        - files
    ProcessedFile:
      type: object
      properties:
        filename:
          type: string
        originalSize:
          type: integer
        finalSize:
          type: integer
        savedPercent:
          type: number
        appliedQuality:
          type: integer
        mimeType:
          type: string
        downloadUrl:
          type: string
        storedFileId:
          type:
            - string
            - 'null'
          format: uuid
      required:
        - filename
        - originalSize
        - finalSize
        - savedPercent
        - mimeType
        - downloadUrl
    StorageStatus:
      type: object
      properties:
        saved:
          type: boolean
        notice:
          type:
            - string
            - 'null'
      required:
        - saved
        - notice
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
  responses:
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/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.

````