convertfilefast-com Image Operations API

openapi: 3.2.0
info:
  title: ConvertFileFast Image Operations API
  description: '## ConvertFileFast API


    API for converting files to PDF format.


    ### Supported Formats


    | Format | Extension | Description |

    |--------|-----------|-------------|

    | Excel | .xlsx | Excel spreadsheets |

    | Word | .doc, .docx | Word documents |

    | PowerPoint | .pptx | PowerPoint presentations |

    | ZIP | .zip | Batch conversion of multiple files |

    | Text | .txt | Plain text files |

    | RTF | .rtf | Rich Text Format |

    | ODT | .odt | OpenDocument Text |


    ### Authentication


    All conversion endpoints require an API Key.


    **Option 1: X-API-Key header**

    ```

    X-API-Key: your-api-key

    ```


    **Option 2: Authorization Bearer**

    ```

    Authorization: Bearer your-api-key

    ```


    ### Quick Example


    ```bash

    curl -X POST "https://api.convertfilefast.com/v1/convert" \

    -H "X-API-Key: your-api-key" \

    -F "file=@document.docx" \

    -o document_converted.pdf

    ```'
  contact:
    name: API Support
    email: support@convertfilefast.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  version: 1.0.0
tags:
- name: Image Operations
paths:
  /v2/image/resize:
    post:
      tags:
      - Image Operations
      summary: Resize an image
      description: 'Resize an image to specified dimensions.


        At least one of `width` or `height` must be provided. If only one dimension is given, the other is calculated proportionally.


        **Fit modes:**

        - `contain`: resize to fit inside the dimensions without cropping (preserves aspect ratio)

        - `cover`: resize and crop to fill exactly (may crop edges)

        - `fill`: stretch to exactly width x height (ignores aspect ratio)


        The `format` field controls the output image format. Defaults to the source format.'
      operationId: resize_image_v2_image_resize_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_resize_image_v2_image_resize_post'
      responses:
        '200':
          description: Successful Response
          content:
            image/png: {}
            image/jpeg: {}
            image/webp: {}
        '400':
          description: Invalid file, unsupported type, bad URL, or invalid parameters
        '401':
          description: Unauthorized - invalid or missing API key
        '429':
          description: Rate limit or monthly limit exceeded
        '500':
          description: Internal error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
  /v2/image/compress:
    post:
      tags:
      - Image Operations
      summary: Compress an image
      description: 'Compress an image to reduce its file size.


        The `quality` parameter (1-100) controls compression aggressiveness for lossy formats (JPEG, WebP). For PNG, it maps to the compression level.


        Optional `max_width` and `max_height` parameters will downscale the image proportionally if it exceeds those dimensions before compressing.


        **Response headers:**

        - `X-Original-Size`: original file size in bytes

        - `X-Compressed-Size`: compressed file size in bytes

        - `X-Compression-Ratio`: percentage size reduction (e.g. ''42%'')'
      operationId: compress_image_v2_image_compress_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_compress_image_v2_image_compress_post'
      responses:
        '200':
          description: Successful Response
          headers:
            X-Original-Size:
              description: Original file size in bytes
              schema:
                type: string
            X-Compressed-Size:
              description: Compressed file size in bytes
              schema:
                type: string
            X-Compression-Ratio:
              description: Percentage size reduction
              schema:
                type: string
          content:
            image/png: {}
            image/jpeg: {}
            image/webp: {}
        '400':
          description: Invalid file, unsupported type, bad URL, or invalid parameters
        '401':
          description: Unauthorized - invalid or missing API key
        '429':
          description: Rate limit or monthly limit exceeded
        '500':
          description: Internal error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
      - APIKeyHeader: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_resize_image_v2_image_resize_post:
      properties:
        file:
          anyOf:
          - type: string
            format: binary
          - type: 'null'
          title: File
          description: Image file to resize
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
          description: URL of image file to resize
        width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width
          description: Target width in pixels
        height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height
          description: Target height in pixels
        fit:
          type: string
          title: Fit
          description: 'Fit mode: contain, cover, or fill'
          default: contain
        format:
          anyOf:
          - type: string
          - type: 'null'
          title: Format
          description: 'Output format: jpeg, png, webp, etc.'
      type: object
      title: Body_resize_image_v2_image_resize_post
    Body_compress_image_v2_image_compress_post:
      properties:
        file:
          anyOf:
          - type: string
            format: binary
          - type: 'null'
          title: File
          description: Image file to compress
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
          description: URL of image file to compress
        quality:
          type: integer
          title: Quality
          description: Compression quality (1-100, higher = better quality)
          default: 85
        format:
          anyOf:
          - type: string
          - type: 'null'
          title: Format
          description: 'Output format: jpeg, png, webp, etc. Defaults to source format.'
        max_width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Width
          description: Maximum output width in pixels (downscales proportionally if exceeded)
        max_height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Height
          description: Maximum output height in pixels (downscales proportionally if exceeded)
      type: object
      title: Body_compress_image_v2_image_compress_post
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key