FOLIO

FOLIO Config API

Provides endpoints to configure search and browse features, such as enabling/disabling specific features or managing language settings.

Documentation GitHub OpenAPI

Operations 10

GET /search/config/languages Get Language Configurations #

POST /search/config/languages Create Language Configuration #

DELETE /search/config/languages/{code} Delete Language Configuration #

PUT /search/config/languages/{code} Update Language Configuration #

GET /search/config/features Get Feature Configurations #

POST /search/config/features Save Feature Configuration #

DELETE /search/config/features/{featureId} Delete Feature Configuration #

PUT /search/config/features/{featureId} Update Feature Configuration #

GET /browse/config/{browseType} Get Browse Configurations #

PUT /browse/config/{browseType}/{browseOptionId} Update Browse Configurations #

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/folio:folio-config-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

openapi: 3.2.0
info:
  contact:
    name: Spitfire team
  description: 'API for searching, browsing, and managing facets for various record types, including instances, holdings, and authorities.

    It also provides endpoints for configuring search and browse features, as well as managing the search index.'
  title: Search Config API
  version: v4.1.0
servers:
- description: Development environments.
  url: https://{environment}-okapi.ci.folio.org
  variables:
    environment:
      default: folio-dev-spitfire
      enum:
      - folio-dev-spitfire
      - folio-perf-spitfire
- description: Reference environments.
  url: https://folio-{environment}-okapi.dev.folio.org
  variables:
    environment:
      default: snapshot
      enum:
      - snapshot
      - snapshot-2
tags:
- description: Provides endpoints to configure search and browse features, such as enabling/disabling specific features or managing language settings.
  name: Config
paths:
  /search/config/languages:
    get:
      description: Get all supported languages
      operationId: getAllLanguageConfigs
      responses:
        '200':
          content:
            application/json:
              examples:
                languageConfigsResponse:
                  value:
                    languageConfigs:
                    - code: eng
                      languageAnalyzer: eng-analyzer
                    - code: ukr
                      languageAnalyzer: ukr-analyzer
                    totalRecords: 2
              schema:
                $ref: '#/components/schemas/languageConfigs'
          description: All supported languages
      summary: Get Language Configurations
      tags:
      - Config
    post:
      description: Save languages that will be used for analyzers
      operationId: createLanguageConfig
      requestBody:
        content:
          application/json:
            examples:
              createLanguageConfigRequest:
                value:
                  code: eng
                  languageAnalyzer: eng-analyzer
            schema:
              $ref: '#/components/schemas/languageConfig'
      responses:
        '200':
          content:
            application/json:
              examples:
                createLanguageConfigResponse:
                  value:
                    code: eng
                    languageAnalyzer: eng-analyzer
              schema:
                $ref: '#/components/schemas/languageConfig'
          description: Language support has been added.
        '422':
          content:
            application/json:
              examples:
                response:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation error for the request.
      summary: Create Language Configuration
      tags:
      - Config
  /search/config/languages/{code}:
    delete:
      description: Delete all supported languages
      operationId: deleteLanguageConfig
      parameters:
      - description: Language code
        in: path
        name: code
        required: true
        schema:
          pattern: '[a-zA-Z]{3}'
          type: string
      responses:
        '204':
          description: Language support has been removed
        '404':
          description: No language support is found
      summary: Delete Language Configuration
      tags:
      - Config
    put:
      description: Update language config settings
      operationId: updateLanguageConfig
      parameters:
      - description: Language code
        in: path
        name: code
        required: true
        schema:
          pattern: '[a-zA-Z]{3}'
          type: string
      requestBody:
        content:
          application/json:
            examples:
              updateLanguageConfigRequest:
                value:
                  code: eng
                  languageAnalyzer: eng-analyzer
            schema:
              $ref: '#/components/schemas/languageConfig'
      responses:
        '200':
          content:
            application/json:
              examples:
                updateLanguageConfigResponse:
                  value:
                    code: eng
                    languageAnalyzer: eng-analyzer
              schema:
                $ref: '#/components/schemas/languageConfig'
          description: Language support has been added.
        '422':
          content:
            application/json:
              examples:
                response:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation error for the request.
      summary: Update Language Configuration
      tags:
      - Config
  /search/config/features:
    get:
      description: Get all feature configurations per tenant
      operationId: getAllFeatures
      responses:
        '200':
          content:
            application/json:
              examples:
                allFeaturesResponse:
                  value:
                    features:
                    - feature: search.all.fields
                      enabled: false
                    totalRecords: 1
              schema:
                $ref: '#/components/schemas/featureConfigs'
          description: All feature configurations
      summary: Get Feature Configurations
      tags:
      - Config
    post:
      description: Save feature configuration (enables or disables pre-defined optional search options)
      operationId: saveFeatureConfiguration
      requestBody:
        content:
          application/json:
            examples:
              createRequest:
                $ref: '#/components/examples/updateCreateFeatureRequest'
            schema:
              $ref: '#/components/schemas/featureConfig'
      responses:
        '200':
          content:
            application/json:
              examples:
                createResponse:
                  $ref: '#/components/examples/updateFeatureResponse'
              schema:
                $ref: '#/components/schemas/featureConfig'
          description: Language support has been added.
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '422':
          content:
            application/json:
              examples:
                response:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation error for the request.
      summary: Save Feature Configuration
      tags:
      - Config
  /search/config/features/{featureId}:
    delete:
      description: Delete feature configuration by id
      operationId: deleteFeatureConfigurationById
      parameters:
      - description: Feature id (name)
        in: path
        name: featureId
        required: true
        schema:
          enum:
          - search.all.fields
          - browse.contributors
          - browse.subjects
          - browse.classifications
          - browse.call-numbers
          type: string
      responses:
        '204':
          description: Feature configuration has been removed
        '404':
          description: No feature configuration is found by id
      summary: Delete Feature Configuration
      tags:
      - Config
    put:
      description: Update feature configuration settings
      operationId: updateFeatureConfiguration
      parameters:
      - description: Feature id (name)
        in: path
        name: featureId
        required: true
        schema:
          enum:
          - search.all.fields
          - browse.contributors
          - browse.subjects
          - browse.classifications
          - browse.call-numbers
          type: string
      requestBody:
        content:
          application/json:
            examples:
              updateRequest:
                $ref: '#/components/examples/updateCreateFeatureRequest'
            schema:
              $ref: '#/components/schemas/featureConfig'
      responses:
        '200':
          content:
            application/json:
              examples:
                updateResponse:
                  $ref: '#/components/examples/updateFeatureResponse'
              schema:
                $ref: '#/components/schemas/featureConfig'
          description: Feature configuration has been added.
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '422':
          content:
            application/json:
              examples:
                response:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation error for the request.
      summary: Update Feature Configuration
      tags:
      - Config
  /browse/config/{browseType}:
    get:
      description: Get all configurations for browse type
      operationId: getBrowseConfigs
      parameters:
      - description: Browse feature type
        in: path
        name: browseType
        required: true
        schema:
          $ref: '#/components/schemas/browseType'
      responses:
        '200':
          content:
            application/json:
              examples:
                configCollection:
                  $ref: '#/components/examples/browseConfigCollectionResponse'
              schema:
                $ref: '#/components/schemas/browseConfigCollection'
          description: All browse configurations for type
      summary: Get Browse Configurations
      tags:
      - Config
  /browse/config/{browseType}/{browseOptionId}:
    put:
      description: Update configuration for browse type
      operationId: putBrowseConfig
      parameters:
      - description: Browse feature type
        in: path
        name: browseType
        required: true
        schema:
          $ref: '#/components/schemas/browseType'
      - description: Browse option type
        in: path
        name: browseOptionId
        required: true
        schema:
          $ref: '#/components/schemas/browseOptionType'
      requestBody:
        content:
          application/json:
            examples:
              updateRequest:
                $ref: '#/components/examples/browseConfigUpdateRequest'
            schema:
              $ref: '#/components/schemas/browseConfig'
        required: true
      responses:
        '200':
          description: Browse configuration has been updated.
        '400':
          content:
            application/json:
              examples:
                validationErrorResponse:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation errors
        '422':
          content:
            application/json:
              examples:
                response:
                  $ref: '#/components/examples/validationErrorResponse'
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Validation error for the request.
      summary: Update Browse Configurations
      tags:
      - Config
components:
  schemas:
    browseConfig:
      example:
        id: all
        shelvingAlgorithm: lc
        typeIds:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        id:
          $ref: '#/components/schemas/browseOptionType'
        shelvingAlgorithm:
          $ref: '#/components/schemas/shelvingOrderAlgorithmType'
        typeIds:
          description: Type IDs that should be used by the option
          items:
            description: Type ID
            format: uuid
            type: string
          type: array
      required:
      - id
      - shelvingAlgorithm
      type: object
    languageConfig:
      additionalProperties: false
      description: Language config
      example:
        code: code
        languageAnalyzer: languageAnalyzer
      properties:
        code:
          description: An ISO-639-2/B compatible language code.
          pattern: '[a-zA-Z]{3}'
          type: string
        languageAnalyzer:
          description: Custom elasticsearch analyzer for language.
          type: string
      required:
      - code
      type: object
    browseConfigCollection:
      example:
        configs:
        - id: all
          shelvingAlgorithm: lc
          typeIds:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - id: all
          shelvingAlgorithm: lc
          typeIds:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        totalRecords: 0
      properties:
        configs:
          items:
            $ref: '#/components/schemas/browseConfig'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        totalRecords:
          type: integer
      type: object
    error:
      description: An error
      properties:
        message:
          description: Error message text
          type: string
        type:
          description: Error message type
          type: string
        code:
          description: Error message code
          type: string
        parameters:
          items:
            $ref: '#/components/schemas/parameter'
          type: array
      type: object
    tenantConfiguredFeature:
      description: The feature name.
      enum:
      - search.all.fields
      - browse.contributors
      - browse.subjects
      - browse.classifications
      - browse.call-numbers
      type: string
    errorResponse:
      description: A set of errors
      example:
        errors:
        - message: Illegal argument error
          type: IllegalArgumentException
          code: unknown_error
        total_records: 1
      properties:
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/error'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        total_records:
          description: Total number of errors
          type: integer
      type: object
    languageConfigs:
      additionalProperties: false
      description: Language config
      example:
        languageConfigs:
        - code: code
          languageAnalyzer: languageAnalyzer
        - code: code
          languageAnalyzer: languageAnalyzer
        totalRecords: 0
      properties:
        languageConfigs:
          description: Configured languages for a tenant
          items:
            $ref: '#/components/schemas/languageConfig'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        totalRecords:
          description: Total records that matches the query.
          minimum: 0
          type: integer
      required:
      - languageConfigs
      - totalRecords
      type: object
    featureConfigs:
      additionalProperties: false
      description: Feature configs response per tenant
      example:
        features:
        - feature: search.all.fields
          enabled: true
        - feature: search.all.fields
          enabled: true
        totalRecords: 0
      properties:
        features:
          description: Configured features per tenant
          items:
            $ref: '#/components/schemas/featureConfig'
          type: array
          x-field-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
        totalRecords:
          description: Total records that matches the query.
          minimum: 0
          type: integer
      required:
      - features
      - totalRecords
      type: object
    parameter:
      description: List of key/value parameters of an error
      example:
        key: source
        value: 'null'
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
      type: object
    shelvingOrderAlgorithmType:
      description: Shelving order algorithm
      enum:
      - lc
      - dewey
      - nlm
      - sudoc
      - default
      type: string
    browseType:
      enum:
      - instance-classification
      - instance-call-number
      type: string
    browseOptionType:
      description: Browse option type
      enum:
      - all
      - lc
      - dewey
      - nlm
      - sudoc
      - other
      type: string
    featureConfig:
      additionalProperties: false
      description: Feature config request value
      example:
        feature: search.all.fields
        enabled: true
      properties:
        feature:
          $ref: '#/components/schemas/tenantConfiguredFeature'
        enabled:
          description: Action - enable or disable option
          type: boolean
      required:
      - enabled
      - feature
      type: object
  examples:
    updateFeatureResponse:
      summary: Disable Search all fields feature.
      value:
        feature: search.all.fields
        enabled: false
    validationErrorResponse:
      value:
        errors:
        - message: must not be null
          type: MethodArgumentNotValidException
          code: validation_error
          parameters:
          - key: parameter
            value: 'null'
        total_records: 1
    browseConfigCollectionResponse:
      value:
        configs:
        - id: all
          shelvingAlgorithm: default
          typeIds: []
        - id: dewey
          shelvingAlgorithm: dewey
          typeIds: []
        - id: lc
          shelvingAlgorithm: lc
          typeIds: []
        totalRecords: 3
    updateCreateFeatureRequest:
      summary: Disable Search all fields feature.
      value:
        feature: search.all.fields
        enabled: false
    browseConfigUpdateRequest:
      value:
        id: all
        shelvingAlgorithm: default
        typeIds:
        - 7e5684a9-c8c1-4c1e-85b9-d047f53eeb6d
        - 1faf5a71-01cc-4f14-82e8-38e26b6e3071

FOLIO Config API

Operations 10

Documentation

Specifications

SDKs

Schemas & Data

Other Resources