Convert To It Formats API

openapi: 3.2.0
info:
  title: Converttoit Com Formats API
  version: 1.0.0
  description: 'Operations tagged Formats across 2 of this provider''s published API definitions: converttoit-com-openapi.json, converttoit-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://converttoit.com/api/v1
security: []
tags:
- name: Formats
paths:
  /formats:
    get:
      operationId: listFormats
      summary: Supported formats, merged across converters
      parameters:
      - name: q
        in: query
        description: Text search over extension, MIME type, name, category and converter.
        schema:
          type: string
        example: heic
      - name: category
        in: query
        description: One or more categories, comma-separated.
        schema:
          type: string
        example: image,video
      - name: from
        in: query
        description: 'true: only formats that can be read (converted from). false: only formats that can''t.'
        schema:
          type: boolean
      - name: to
        in: query
        description: 'true: only formats that can be written (converted to). false: only formats that can''t.'
        schema:
          type: boolean
      responses:
        '200':
          description: Formats matching the filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormatList'
        '400':
          description: 'from or to is not a boolean (error: invalid_filter).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      tags:
      - Formats
    servers:
    - url: https://converttoit.com/api/v1
components:
  responses:
    RateLimited:
      description: 'More than 60 requests in 60 seconds from this IP (error: rate_limited).'
      headers:
        retry-after:
          description: Seconds to wait before retrying.
          schema:
            type: integer
        x-ratelimit-limit:
          schema:
            type: integer
        x-ratelimit-remaining:
          schema:
            type: integer
        x-ratelimit-source:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServiceUnavailable:
      description: 'The format list could not be loaded (error: service_unavailable).'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      - requestId
      properties:
        error:
          type: string
          enum:
          - invalid_filter
          - not_found
          - method_not_allowed
          - rate_limited
          - service_unavailable
        requestId:
          type: string
        message:
          type: string
        retryAfter:
          type: integer
          description: Seconds to wait (rate_limited only).
        source:
          type: string
          description: Where the limit was enforced (rate_limited only).
    Format:
      type: object
      required:
      - name
      - format
      - extension
      - mime
      - category
      - from
      - to
      - lossless
      - handlers
      properties:
        name:
          type: string
          example: High Efficiency Image Format
        format:
          type: string
          example: heic
        extension:
          type: string
          example: heic
        mime:
          type: string
          example: image/heic
        category:
          $ref: '#/components/schemas/Category'
        from:
          type: boolean
          description: Can be read (converted from).
        to:
          type: boolean
          description: Can be written (converted to).
        lossless:
          type: boolean
        handlers:
          type: array
          items:
            type: string
          description: Converters that support the format.
          example:
          - ImageMagick
    FormatList:
      type: object
      required:
      - ok
      - requestId
      - count
      - total
      - filters
      - items
      properties:
        ok:
          type: boolean
          const: true
        requestId:
          type: string
        count:
          type: integer
          description: Formats returned.
        total:
          type: integer
          description: Formats before filtering.
        filters:
          type: object
          properties:
            category:
              type:
              - array
              - 'null'
              items:
                type: string
            from:
              type:
              - boolean
              - 'null'
            to:
              type:
              - boolean
              - 'null'
            q:
              type:
              - string
              - 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/Format'
    Category:
      description: One category, several, or null when the format has none.
      type:
      - string
      - array
      - 'null'
      items:
        type: string
      example: image
externalDocs:
  description: API documentation
  url: https://converttoit.com/api
x-refined-from:
- converttoit-com-openapi.json
- converttoit-com-openapi.yml