# Flying Sphinx API

**Canonical:** https://apis.io/apis/flying-sphinx/flying-sphinx-api/  
**Provider:** Flying Sphinx — https://apis.io/providers/flying-sphinx/  
**Base URL:** https://flying-sphinx.com  
**Documentation:** https://info.flying-sphinx.com/api

Flying Sphinx API is one of 2 APIs that [Flying Sphinx](https://apis.io/providers/flying-sphinx/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

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.

## Operations (10)

| Method | Path | Summary |
|---|---|---|
| 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 ... |
| 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 |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/flying-sphinx/openapi/_ae-authored/flying-sphinx-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-post-api-my-v5-perform-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-get-api-my-v5-presignature-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-get-api-my-app-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-post-api-my-app-add-file-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-put-api-my-app-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/flying-sphinx/json-schema/flying-sphinx-get-api-my-app-indices-id-response-schema.json

## Other Flying Sphinx APIs (1)

- [Flying Sphinx API](https://apis.io/apis/flying-sphinx/flying-sphinx-api-2/)

## Use this from code or an agent

- **REST, no key:** `GET https://apis.io/api/v1/providers/flying-sphinx` returns the provider's full profile as JSON.
- **MCP:** `https://apis.io/mcp` (Streamable HTTP) — search the catalog, read any provider, compare providers, check agent readiness.
- **Free API key** for catalog-wide search, ratings and comparisons: sign in with GitHub, Google or LinkedIn at https://apis.io/developer/account/ (plans: https://apis.io/developer/plans/).

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/flying-sphinx/flying-sphinx-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/flying-sphinx/.
