> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.aegi.run/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.aegi.run/_mcp/server. # API Reference ## API Docs - Aegis > General [API Root Banner](https://docs.aegi.run/api-reference/aegis/general/api-root-banner.md) - Aegis > General [Check the status of the API](https://docs.aegi.run/api-reference/aegis/general/check-the-status-of-the-api.md) - Aegis > Image [Filter an image](https://docs.aegi.run/api-reference/aegis/image/filter-an-image.md) - Aegis > Image [Overlay an image](https://docs.aegi.run/api-reference/aegis/image/overlay-an-image.md) - Aegis > Tools [Take a screenshot from a website.](https://docs.aegi.run/api-reference/aegis/tools/take-a-screenshot-from-a-website.md) - Aegis > Tools [Encode text to binary](https://docs.aegi.run/api-reference/aegis/tools/encode-text-to-binary.md) - Aegis > Tools [Decode binary to text](https://docs.aegi.run/api-reference/aegis/tools/decode-binary-to-text.md) - Aegis > Fun [Returns a GIF of an action scene from an anime.](https://docs.aegi.run/api-reference/aegis/fun/returns-a-gif-of-an-action-scene-from-an-anime.md) - Aegis > Translation [Translate text from one language to another](https://docs.aegi.run/api-reference/aegis/translation/translate-text-from-one-language-to-another.md) - Aegis > Translation [Detect the language of a given text](https://docs.aegi.run/api-reference/aegis/translation/detect-the-language-of-a-given-text.md) - Aegis > Translation [Get a list of supported languages for translation](https://docs.aegi.run/api-reference/aegis/translation/get-a-list-of-supported-languages-for-translation.md) - Aegis > Roblox [Get Roblox user information by ID or Username](https://docs.aegi.run/api-reference/aegis/roblox/get-roblox-user-information-by-id-or-username.md) - Aegis > Roblox [Get detailed Roblox game information by Universe ID or Place ID](https://docs.aegi.run/api-reference/aegis/roblox/get-detailed-roblox-game-information-by-universe-id-or-place-id.md) - Aegis > Minecraft [Minecraft player information](https://docs.aegi.run/api-reference/aegis/minecraft/player-information.md) - Aegis > Minecraft [Minecraft player textures](https://docs.aegi.run/api-reference/aegis/minecraft/player-textures.md) - Aegis > Minecraft [Queue a Minecraft player render](https://docs.aegi.run/api-reference/aegis/minecraft/queue-a-minecraft-player-render.md) - Aegis > Holidays [Get the next public holidays for a specific country](https://docs.aegi.run/api-reference/aegis/holidays/get-the-next-public-holidays-for-a-specific-country.md) - Aegis > Holidays [Get public holidays for a specific country and year](https://docs.aegi.run/api-reference/aegis/holidays/get-public-holidays-for-a-specific-country-and-year.md) - Aegis > Bible [List available source languages](https://docs.aegi.run/api-reference/aegis/bible/list-available-source-languages.md) - Aegis > Bible [List available types for a language](https://docs.aegi.run/api-reference/aegis/bible/list-available-types-for-a-language.md) - Aegis > Bible [List known translations](https://docs.aegi.run/api-reference/aegis/bible/list-known-translations.md) - Aegis > Bible [List books of a translation](https://docs.aegi.run/api-reference/aegis/bible/list-books-of-a-translation.md) - Aegis > Bible [Get all verses of a chapter](https://docs.aegi.run/api-reference/aegis/bible/get-all-verses-of-a-chapter.md) - Aegis > Bible [Search verses containing a query](https://docs.aegi.run/api-reference/aegis/bible/search-verses-containing-a-query.md) - Aegis > Bible [Get specific verses by reference](https://docs.aegi.run/api-reference/aegis/bible/get-specific-verses-by-reference.md) - Aegis > Bible [Get a summary of a raw source file](https://docs.aegi.run/api-reference/aegis/bible/get-a-summary-of-a-raw-source-file.md) - Aegis > Jobs [Job status](https://docs.aegi.run/api-reference/aegis/jobs/job-status.md) - Aegis > Jobs [Wait for a job to finish](https://docs.aegi.run/api-reference/aegis/jobs/wait-for-a-job-to-finish.md) - Aegis > Music [Play or queue a track](https://docs.aegi.run/api-reference/aegis/music/play-or-queue-a-track.md) - Aegis > Music [Pause](https://docs.aegi.run/api-reference/aegis/music/pause.md) - Aegis > Music [Resume](https://docs.aegi.run/api-reference/aegis/music/resume.md) - Aegis > Music [Skip to the next track](https://docs.aegi.run/api-reference/aegis/music/skip-to-the-next-track.md) - Aegis > Music [Stop and leave](https://docs.aegi.run/api-reference/aegis/music/stop-and-leave.md) - Aegis > Music [Play the current track again](https://docs.aegi.run/api-reference/aegis/music/play-the-current-track-again.md) - Aegis > Music [Current track and player state](https://docs.aegi.run/api-reference/aegis/music/current-track-and-player-state.md) - Aegis > Music [Clear the queue](https://docs.aegi.run/api-reference/aegis/music/clear-the-queue.md) - Aegis > Music [Shuffle the queue](https://docs.aegi.run/api-reference/aegis/music/shuffle-the-queue.md) - Aegis > Music [Remove a queued track](https://docs.aegi.run/api-reference/aegis/music/remove-a-queued-track.md) - Aegis > Music [Move a queued track](https://docs.aegi.run/api-reference/aegis/music/move-a-queued-track.md) - Aegis > Music [Current volume](https://docs.aegi.run/api-reference/aegis/music/current-volume.md) - Aegis > Music [Set the volume](https://docs.aegi.run/api-reference/aegis/music/set-the-volume.md) - Aegis > Music [Mute](https://docs.aegi.run/api-reference/aegis/music/mute.md) - Aegis > Music [Unmute](https://docs.aegi.run/api-reference/aegis/music/unmute.md) - Aegis > Music [Jump to a position](https://docs.aegi.run/api-reference/aegis/music/jump-to-a-position.md) - Aegis > Music [Current loop mode](https://docs.aegi.run/api-reference/aegis/music/current-loop-mode.md) - Aegis > Music [Set the loop mode](https://docs.aegi.run/api-reference/aegis/music/set-the-loop-mode.md) - Aegis > Music [Search for tracks](https://docs.aegi.run/api-reference/aegis/music/search-for-tracks.md) - Aegis > Music [Current fading setup](https://docs.aegi.run/api-reference/aegis/music/current-fading-setup.md) - Aegis > Music [Set the fading](https://docs.aegi.run/api-reference/aegis/music/set-the-fading.md) - Aegis > Music [Whether gapless preloading is on](https://docs.aegi.run/api-reference/aegis/music/whether-gapless-preloading-is-on.md) - Aegis > Music [Set gapless preloading](https://docs.aegi.run/api-reference/aegis/music/set-gapless-preloading.md) - Aegis > Music [Current audio filters](https://docs.aegi.run/api-reference/aegis/music/current-audio-filters.md) - Aegis > Music [Set the audio filters](https://docs.aegi.run/api-reference/aegis/music/set-the-audio-filters.md) - Aegis > Music [List the mix layers](https://docs.aegi.run/api-reference/aegis/music/list-the-mix-layers.md) - Aegis > Music [Add a mix layer](https://docs.aegi.run/api-reference/aegis/music/add-a-mix-layer.md) - Aegis > Music [Remove a mix layer](https://docs.aegi.run/api-reference/aegis/music/remove-a-mix-layer.md) - Aegis > Music [Set a layer volume](https://docs.aegi.run/api-reference/aegis/music/set-a-layer-volume.md) - Aegis > Music [Background on a track](https://docs.aegi.run/api-reference/aegis/music/background-on-a-track.md) - Aegis > Music [Lyrics for a track](https://docs.aegi.run/api-reference/aegis/music/lyrics-for-a-track.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.aegi.run/openapi.json) - [OpenAPI YAML](https://docs.aegi.run/openapi.yaml) > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.aegi.run/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.aegi.run/_mcp/server. # API reference Fern automatically generates interactive API reference documentation from your API specification. This starter template includes a sample Plant Store API to demonstrate the feature. ## Supported specifications Fern supports multiple API specification formats: | Format | Description | Documentation | | ------------ | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | **OpenAPI** | The most widely used REST API specification format (versions 2.0, 3.0, and 3.1) | [OpenAPI docs](https://buildwithfern.com/learn/api-definitions/openapi/overview) | | **AsyncAPI** | For event-driven and message-based APIs | [AsyncAPI docs](https://buildwithfern.com/learn/api-definitions/asyncapi) | | **gRPC** | Protocol buffer definitions for gRPC services | [gRPC docs](https://buildwithfern.com/learn/api-definitions/protobuf) | ## How it works Place your API specification file in the `fern/` directory and reference it in your `docs.yml` navigation: **`docs.yml`** ```yaml title="docs.yml" navigation: - section: Documentation contents: - page: Overview path: docs/pages/overview.mdx - api: API Reference ``` Fern parses your specification and generates: * Endpoint documentation with request/response schemas * Interactive API Explorer for testing endpoints * Code snippets in multiple languages * Type definitions and examples ## API Explorer The API Explorer lets users test API endpoints directly in the documentation. Users can fill in parameters, send requests, and see responses without leaving the page. > **Note** > > For advanced API Explorer features like auto-populating API keys, see the [API Explorer documentation](https://buildwithfern.com/learn/docs/api-references/api-explorer/overview). ## Customizing the API reference Control how your API reference appears using the `api` configuration in `docs.yml`: **`docs.yml`** ```yaml title="docs.yml" navigation: - api: API Reference api-name: plantstore paginated: true ``` You can also add custom content to API reference pages, organize endpoints into groups, customize section names, and control which endpoints are visible. > **Note** > > For detailed customization options, see the [API reference documentation](https://buildwithfern.com/learn/docs/api-references/generate-api-ref). ## SDK code snippets If you generate SDKs with Fern, code snippets automatically appear in your API reference showing how to call each endpoint using your SDK: **`generators.yml`** ```yaml title="generators.yml" groups: python-sdk: generators: - name: fernapi/fern-python-sdk version: 4.3.1 output: location: pypi package-name: plantstore ``` > **Note** > > For more information on SDK generation, see the [SDK documentation](https://buildwithfern.com/learn/sdks/overview/introduction).