Flexim API

openapi: 3.1.0
info:
  title: Flexim API
  version: '2026-11-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-08: 6 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Flexim has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 6
    pages-with-code: 0
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://flexim.io/docs/api-docs/image-delivery
  - https://flexim.io/docs/api-docs/collection-operations
  - https://flexim.io/docs/api-docs/single-page-operations
paths:
  /api/v1/main/data/collections/books/5f8d43e1a8c7f31d8c1b7b3a:
    delete:
      operationId: delete_api_v1_main_data_collections_books_5f8d43e1a8c7f31d8c1b7b3a
      tags:
      - Api
      summary: Moves a specific object to the trash (soft delete).
      x-source: https://flexim.io/docs/api-docs/single-page-operations
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_v1_main_data_collections_books_5f8d43e1a8c7f31d8c1b7b3a
      tags:
      - Api
      summary: Retrieves information about a specific object by its ID.
      x-source: https://flexim.io/docs/api-docs/single-page-operations
      parameters:
      - name: selectFields
        in: query
        required: false
        schema:
          type: string
        description: comma-separated field projection
      - name: populate
        in: query
        required: false
        schema:
          type: string
        description: relation fields to expand
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_v1_main_data_collections_books_5f8d43e1a8c7f31d8c1b7b3a
      tags:
      - Api
      summary: Updates information for a specific object.
      x-source: https://flexim.io/docs/api-docs/single-page-operations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiV1MainDataCollectionsBooks5F8D43E1A8C7F31D8C1B7B3ARequ'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/main/data/collections/test_collection:
    get:
      operationId: get_api_v1_main_data_collections_test_collection
      tags:
      - Api
      summary: Retrieve Objects from a Collection
      x-source: https://flexim.io/docs/api-docs/collection-operations
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
        description: 'The page number to retrieve. Default limit: 10 records per page. If not specified, returns all objects in the collection.'
      - name: select
        in: query
        required: false
        schema:
          type: string
        description: Temporarily inactive. Was intended to return only the fields configured in the CMS shared view (shareCollections).
      - name: selectFields
        in: query
        required: false
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Used to reduce response size and time. Note: does not work on
          relation fields due to the deepPopulate setting.'
      - name: populate
        in: query
        required: false
        schema:
          type: string
        description: Comma- or space-separated relation fields to expand in the response.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_main_data_collections_test_collection
      tags:
      - Api
      summary: Create a New Object
      x-source: https://flexim.io/docs/api-docs/collection-operations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1MainDataCollectionsTestCollectionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/v1/{spacename}/pictures/{mediaid}:
    get:
      operationId: get_api_v1_spacename_pictures_mediaid
      tags:
      - Api
      summary: Image Delivery
      description: Deliver original and transformed Flexim images with responsive widths, quality controls, modern formats, caching, and safe
        fallbacks. Returns a 302 redirect to the master or generated variant. Invalid parameters return 400, unknown media ID returns 404, rate
        limiting returns 429.
      x-source: https://flexim.io/docs/api-docs/image-delivery
      parameters:
      - name: spacename
        in: path
        required: true
        schema:
          type: string
      - name: mediaid
        in: path
        required: true
        schema:
          type: string
      - name: w
        in: query
        required: false
        schema:
          type: integer
        description: Requested width. Integer from 1 to 8192.
      - name: q
        in: query
        required: false
        schema:
          type: integer
        description: 'Quality for the new variant. Default: 80. Allowed values: 80, 90, 95, 100.'
      - name: fm
        in: query
        required: false
        schema:
          type: string
        description: Explicit output format. jpeg, png, webp, avif.
      - name: auto
        in: query
        required: false
        schema:
          type: string
        description: Format negotiation. Use "format" to enable auto format selection.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PutApiV1MainDataCollectionsBooks5F8D43E1A8C7F31D8C1B7B3ARequ:
      type: object
      properties:
        body:
          type: string
          description: The request body depends on the schema of the collection/page being updated.
      required:
      - body
    PostApiV1MainDataCollectionsTestCollectionRequest:
      type: object
      properties:
        body:
          type: string
          description: The request body depends on the schema of the collection/page. The structure is dynamic based on the collection's or page's
            fields.
      required:
      - body
tags:
- name: Api