Flying Sphinx API

Flying Sphinx API as documented publicly: 10 operations. Contract generated from the documentation by API Evangelist (2026-11-16); not the provider's own document.

GitHub OpenAPI

Operations 10

GET /api/my/app Retrieve connection information for searching #
PUT /api/my/app Sphinx Configuration #
POST /api/my/app/add_file Add a supplemental file for a Sphinx setting #
POST /api/my/app/indices Initiate processing of Sphinx indices #
GET /api/my/app/indices/{id} Check status of an index processing job #
POST /api/my/app/start Start the Sphinx daemon #
POST /api/my/app/stop Stop the Sphinx daemon #
GET /api/my/v5/app Searching is done by connecting to Sphinx directly - and the address and port are provided through the FLYING_SPHINX_HOST and FLYING_SPHINX_PORT environment variables. You can also #
POST /api/my/v5/perform All actions to manage the configuration, running state and indexing are managed through a single endpoint #
GET /api/my/v5/presignature Requesting pre-signature credentials for configuration uploads #

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/flying-sphinx:flying-sphinx-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

flying-sphinx-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Flying Sphinx API
  version: '2026-11-16'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-16: 10 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Flying Sphinx has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 10
    pages-with-code: 0
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-16'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://info.flying-sphinx.com/api
  - https://info.flying-sphinx.com/api-v3
servers:
- url: https://flying-sphinx.com
paths:
  /api/my/app:
    get:
      operationId: get_api_my_app
      tags:
      - Api
      summary: Retrieve connection information for searching
      x-source: https://info.flying-sphinx.com/api-v3
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiMyAppResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_api_my_app
      tags:
      - Api
      summary: Sphinx Configuration
      x-source: https://info.flying-sphinx.com/api-v3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutApiMyAppRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutApiMyAppResponse'
      x-evidence:
        kind: documentation
  /api/my/app/add_file:
    post:
      operationId: post_api_my_app_add_file
      tags:
      - Api
      summary: Add a supplemental file for a Sphinx setting
      x-source: https://info.flying-sphinx.com/api-v3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiMyAppAddFileRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMyAppAddFileResponse'
      x-evidence:
        kind: documentation
  /api/my/app/indices:
    post:
      operationId: post_api_my_app_indices
      tags:
      - Api
      summary: Initiate processing of Sphinx indices
      x-source: https://info.flying-sphinx.com/api-v3
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiMyAppIndicesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMyAppIndicesResponse'
      x-evidence:
        kind: documentation
  /api/my/app/indices/{id}:
    get:
      operationId: get_api_my_app_indices_id
      tags:
      - Api
      summary: Check status of an index processing job
      x-source: https://info.flying-sphinx.com/api-v3
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiMyAppIndicesIdResponse'
      x-evidence:
        kind: documentation
  /api/my/app/start:
    post:
      operationId: post_api_my_app_start
      tags:
      - Api
      summary: Start the Sphinx daemon
      x-source: https://info.flying-sphinx.com/api-v3
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMyAppStartResponse'
      x-evidence:
        kind: documentation
  /api/my/app/stop:
    post:
      operationId: post_api_my_app_stop
      tags:
      - Api
      summary: Stop the Sphinx daemon
      x-source: https://info.flying-sphinx.com/api-v3
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMyAppStopResponse'
      x-evidence:
        kind: documentation
  /api/my/v5/app:
    get:
      operationId: get_api_my_v5_app
      tags:
      - Api
      summary: Searching is done by connecting to Sphinx directly - and the address and port are provided through the FLYING_SPHINX_HOST and FLYING_SPHINX_PORT
        environment variables. You can also access this informa
      description: Provides the server and port information needed to connect to Sphinx for searching.
      x-source: https://info.flying-sphinx.com/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiMyV5AppResponse'
      x-evidence:
        kind: documentation
  /api/my/v5/perform:
    post:
      operationId: post_api_my_v5_perform
      tags:
      - Api
      summary: All actions to manage the configuration, running state and indexing are managed through a single endpoint
      description: Register an action such as clear, configure, index, merge, rebuild, reset, restart, rotate, start, or stop.
      x-source: https://info.flying-sphinx.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiMyV5PerformRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiMyV5PerformResponse'
      x-evidence:
        kind: documentation
  /api/my/v5/presignature:
    get:
      operationId: get_api_my_v5_presignature
      tags:
      - Api
      summary: Requesting pre-signature credentials for configuration uploads
      description: Retrieve a unique set of credentials for uploading a gzipped tar archive containing the Sphinx configuration files.
      x-source: https://info.flying-sphinx.com/api
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiMyV5PresignatureResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiMyAppResponse:
      type: object
      properties:
        server:
          type: string
          description: The server to direct search queries to.
        port:
          type: integer
          description: The port to connect through to talk to Sphinx.
        ssh_server:
          type: string
          description: Legacy setting for Heroku's shared database servers (not useful now).
        database_port:
          type: integer
          description: Legacy setting for Heroku's shared database servers (not useful now).
    PutApiMyAppRequest:
      type: object
      properties:
        configuration:
          type: string
          description: The contents of a Sphinx configuration file.
        sphinx_version:
          type: string
          description: Optional indicator of the Sphinx version you wish to use. Allowed values are 1.10, 2.1.0-beta and 2.0.4.
      required:
      - configuration
    PutApiMyAppResponse:
      type: object
      properties:
        status:
          type: string
          description: OK
    PostApiMyAppAddFileRequest:
      type: object
      properties:
        setting:
          type: string
          description: The setting in question, matching the setting in the Sphinx configuration (e.g., wordforms).
        file_name:
          type: string
          description: The name of the file – only the name, not the path.
        content:
          type: string
          description: The contents of the file.
      required:
      - setting
      - file_name
      - content
    PostApiMyAppAddFileResponse:
      type: object
      properties:
        status:
          type: string
          description: OK
    PostApiMyAppIndicesRequest:
      type: object
      properties:
        indices:
          type: string
          description: Optional comma‑separated list of index names to be processed. If omitted, all indices are processed.
    PostApiMyAppIndicesResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the process that has just begun.
        status:
          type: string
          description: OK
    GetApiMyAppIndicesIdResponse:
      type: object
      properties:
        status:
          type: string
          description: The process status – either PENDING, FINISHED or FAILED.
        log:
          type: string
          description: The output from Sphinx's indexer (blank unless processing has finished).
    PostApiMyAppStartResponse:
      type: object
      properties:
        status:
          type: string
          description: OK (or 409 if starting fails).
    PostApiMyAppStopResponse:
      type: object
      properties:
        status:
          type: string
          description: OK
    GetApiMyV5AppResponse:
      type: object
      properties:
        server:
          type: string
          description: The server to direct search queries to.
        port:
          type: integer
          description: The port to connect through to talk to Sphinx.
    PostApiMyV5PerformRequest:
      type: object
      properties:
        action:
          type: string
          description: The type of action to register. Available options are listed below.
        path:
          type: string
          description: Optional string of the path where a configuration file has been uploaded.
        indices:
          type: string
          description: Optional string which lists the names of indexes to process when performing the index action.
        core_index:
          type: string
          description: Optional string which is the name of the core index for delta documents to be merged into.
        delta_index:
          type: string
          description: Optional string which is the name of the index that delta documents are sourced from.
        filters:
          type: object
          description: Optional JSON object of filters to determine which delta documents are included.
      required:
      - action
    PostApiMyV5PerformResponse:
      type: object
      properties:
        status:
          type: string
          description: a string indicating whether the action was registered (OK, BLOCKED, UNCONFIGURED, etc.)
        id:
          type: integer
          description: The unique integer representing the action.
    GetApiMyV5PresignatureResponse:
      type: object
      properties:
        status:
          type: string
          description: a string indicating whether the action was registered.
        path:
          type: string
          description: The unique path which can be passed in when registering actions after this file is uploaded.
        url:
          type: string
          description: The URL to POST the configuration archive to.
        fields:
          type: object
          description: The form parameters to include when uploading the configuration archive.
tags:
- name: Api