Maintainerr

Maintainerr API

Maintainerr API as documented publicly: 43 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

GitHub OpenAPI

Operations 43

POST /api/collections/media/handle Run the configured collection action immediately for one item from the collection detail modal #
GET /api/collections/overlay-data Returns collections with full media membership for overlay consumers, including the Calendar page #
GET /api/metadata/backdrop/{type} Resolve a backdrop image for a movie or show from the configured metadata providers #
GET /api/metadata/image/{type} Resolve a poster image for a movie or show from the configured metadata providers #
GET /api/overlays/fonts List available fonts #
POST /api/overlays/fonts Upload a .ttf , .otf , or .woff font #
GET /api/overlays/fonts/{name} Read a bundled or uploaded font file #
GET /api/overlays/images List uploaded overlay image assets #
POST /api/overlays/images Upload a .png , .jpg / .jpeg , or .webp image for template image elements #
DELETE /api/overlays/images/{name} Delete an uploaded overlay image asset #
GET /api/overlays/images/{name} Read an uploaded overlay image asset #
GET /api/overlays/poster Proxy media artwork for template preview #
POST /api/overlays/process Run overlay processing for all eligible collections #
POST /api/overlays/process/{collectionid} Run overlay processing for one collection #
GET /api/overlays/random-episode Get a random episode for title-card preview #
GET /api/overlays/random-item Get a random media item for poster-template preview #
DELETE /api/overlays/reset Revert all overlays #
POST /api/overlays/revert/{collectionid} Revert overlays for one collection #
GET /api/overlays/sections GET /api/overlays/sections #
GET /api/overlays/settings Read global overlay settings #
PUT /api/overlays/settings Update global overlay settings #
GET /api/overlays/status Read the latest overlay processing status #
GET /api/overlays/templates List overlay templates #
POST /api/overlays/templates Create a template #
DELETE /api/overlays/templates/{id} Delete a non-preset template #
GET /api/overlays/templates/{id} Fetch one template #
PUT /api/overlays/templates/{id} Update a template #
POST /api/overlays/templates/{id}/default Set a template as the default for its mode #
POST /api/overlays/templates/{id}/duplicate Clone a template into an editable copy #
POST /api/overlays/templates/{id}/export Export a template as JSON #
POST /api/overlays/templates/{id}/preview Render a server-side preview of a template on real artwork #
POST /api/overlays/templates/import Import a template from JSON #
GET /api/settings/metadata-provider Read which metadata provider is currently primary #
POST /api/settings/metadata-provider Change the primary metadata provider #
POST /api/settings/metadata/refresh/{provider} Clear cached metadata for TMDB or TVDB and queue a media-server refresh pass #
DELETE /api/settings/tmdb Remove the saved TMDB API key #
GET /api/settings/tmdb Read the saved TMDB API key state #
POST /api/settings/tmdb Save a TMDB API key #
DELETE /api/settings/tvdb Remove the saved TVDB API key #
GET /api/settings/tvdb Read the saved TVDB API key state #
POST /api/settings/tvdb Save a TVDB API key #
GET /api/storage-metrics Return aggregated disk usage, instance health, and collection-size summaries #
GET /api/storage-metrics/library-sizes Compute per-library sizes on demand; potentially slow on large libraries #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/maintainerr/openapi/_ae-authored/maintainerr-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/maintainerr/json-schema/maintainerr-post-api-overlays-images-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/maintainerr:maintainerr-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

maintainerr-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Maintainerr API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 43 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; Maintainerr has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 43
    pages-with-code: 0
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.maintainerr.info/3.8.0/api
  - https://docs.maintainerr.info/3.10.0/api
  - https://docs.maintainerr.info/3.10.1/api
paths:
  /api/collections/media/handle:
    post:
      operationId: post_api_collections_media_handle
      tags:
      - Api
      summary: Run the configured collection action immediately for one item from the collection detail modal
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/collections/overlay-data:
    get:
      operationId: get_api_collections_overlay_data
      tags:
      - Api
      summary: Returns collections with full media membership for overlay consumers, including the Calendar page
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/metadata/backdrop/{type}:
    get:
      operationId: get_api_metadata_backdrop_type
      tags:
      - Api
      summary: Resolve a backdrop image for a movie or show from the configured metadata providers
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/metadata/image/{type}:
    get:
      operationId: get_api_metadata_image_type
      tags:
      - Api
      summary: Resolve a poster image for a movie or show from the configured metadata providers
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/fonts:
    get:
      operationId: get_api_overlays_fonts
      tags:
      - Api
      summary: List available fonts
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_overlays_fonts
      tags:
      - Api
      summary: Upload a .ttf , .otf , or .woff font
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/fonts/{name}:
    get:
      operationId: get_api_overlays_fonts_name
      tags:
      - Api
      summary: Read a bundled or uploaded font file
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/images:
    get:
      operationId: get_api_overlays_images
      tags:
      - Api
      summary: List uploaded overlay image assets
      x-source: https://docs.maintainerr.info/3.10.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_overlays_images
      tags:
      - Api
      summary: Upload a .png , .jpg / .jpeg , or .webp image for template image elements
      x-source: https://docs.maintainerr.info/3.10.0/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiOverlaysImagesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/images/{name}:
    delete:
      operationId: delete_api_overlays_images_name
      tags:
      - Api
      summary: Delete an uploaded overlay image asset
      x-source: https://docs.maintainerr.info/3.10.0/api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_overlays_images_name
      tags:
      - Api
      summary: Read an uploaded overlay image asset
      x-source: https://docs.maintainerr.info/3.10.0/api
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/poster:
    get:
      operationId: get_api_overlays_poster
      tags:
      - Api
      summary: Proxy media artwork for template preview
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/process:
    post:
      operationId: post_api_overlays_process
      tags:
      - Api
      summary: Run overlay processing for all eligible collections
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/process/{collectionid}:
    post:
      operationId: post_api_overlays_process_collectionid
      tags:
      - Api
      summary: Run overlay processing for one collection
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: collectionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/random-episode:
    get:
      operationId: get_api_overlays_random_episode
      tags:
      - Api
      summary: Get a random episode for title-card preview
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/random-item:
    get:
      operationId: get_api_overlays_random_item
      tags:
      - Api
      summary: Get a random media item for poster-template preview
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/reset:
    delete:
      operationId: delete_api_overlays_reset
      tags:
      - Api
      summary: Revert all overlays
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/revert/{collectionid}:
    post:
      operationId: post_api_overlays_revert_collectionid
      tags:
      - Api
      summary: Revert overlays for one collection
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: collectionid
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/sections:
    get:
      operationId: get_api_overlays_sections
      tags:
      - Api
      summary: GET /api/overlays/sections
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/settings:
    get:
      operationId: get_api_overlays_settings
      tags:
      - Api
      summary: Read global overlay settings
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_overlays_settings
      tags:
      - Api
      summary: Update global overlay settings
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/status:
    get:
      operationId: get_api_overlays_status
      tags:
      - Api
      summary: Read the latest overlay processing status
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates:
    get:
      operationId: get_api_overlays_templates
      tags:
      - Api
      summary: List overlay templates
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_overlays_templates
      tags:
      - Api
      summary: Create a template
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/{id}:
    delete:
      operationId: delete_api_overlays_templates_id
      tags:
      - Api
      summary: Delete a non-preset template
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_overlays_templates_id
      tags:
      - Api
      summary: Fetch one template
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_overlays_templates_id
      tags:
      - Api
      summary: Update a template
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/{id}/default:
    post:
      operationId: post_api_overlays_templates_id_default
      tags:
      - Api
      summary: Set a template as the default for its mode
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/{id}/duplicate:
    post:
      operationId: post_api_overlays_templates_id_duplicate
      tags:
      - Api
      summary: Clone a template into an editable copy
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/{id}/export:
    post:
      operationId: post_api_overlays_templates_id_export
      tags:
      - Api
      summary: Export a template as JSON
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/{id}/preview:
    post:
      operationId: post_api_overlays_templates_id_preview
      tags:
      - Api
      summary: Render a server-side preview of a template on real artwork
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/overlays/templates/import:
    post:
      operationId: post_api_overlays_templates_import
      tags:
      - Api
      summary: Import a template from JSON
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/settings/metadata-provider:
    get:
      operationId: get_api_settings_metadata_provider
      tags:
      - Api
      summary: Read which metadata provider is currently primary
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_settings_metadata_provider
      tags:
      - Api
      summary: Change the primary metadata provider
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/settings/metadata/refresh/{provider}:
    post:
      operationId: post_api_settings_metadata_refresh_provider
      tags:
      - Api
      summary: Clear cached metadata for TMDB or TVDB and queue a media-server refresh pass
      x-source: https://docs.maintainerr.info/3.8.0/api
      parameters:
      - name: provider
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/settings/tmdb:
    delete:
      operationId: delete_api_settings_tmdb
      tags:
      - Api
      summary: Remove the saved TMDB API key
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_settings_tmdb
      tags:
      - Api
      summary: Read the saved TMDB API key state
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_settings_tmdb
      tags:
      - Api
      summary: Save a TMDB API key
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/settings/tvdb:
    delete:
      operationId: delete_api_settings_tvdb
      tags:
      - Api
      summary: Remove the saved TVDB API key
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_api_settings_tvdb
      tags:
      - Api
      summary: Read the saved TVDB API key state
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_settings_tvdb
      tags:
      - Api
      summary: Save a TVDB API key
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/storage-metrics:
    get:
      operationId: get_api_storage_metrics
      tags:
      - Api
      summary: Return aggregated disk usage, instance health, and collection-size summaries
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/storage-metrics/library-sizes:
    get:
      operationId: get_api_storage_metrics_library_sizes
      tags:
      - Api
      summary: Compute per-library sizes on demand; potentially slow on large libraries
      x-source: https://docs.maintainerr.info/3.8.0/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiOverlaysImagesRequest:
      type: object
      properties:
        file:
          type: string
          description: Image file (.png, .jpg, .jpeg, .webp)
      required:
      - file
tags:
- name: Api