> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.homemediadb.com/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.homemediadb.com/_mcp/server. # API Reference ## API Docs - HMDb API > Configuration [Details](https://docs.homemediadb.com/api-reference/hm-db-api/configuration/details.md) - HMDb API > Releases [Details](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-by-id.md) - HMDb API > Releases [Discs](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-discs.md) - HMDb API > Releases [Tapes](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-tapes.md) - HMDb API > Releases [Components](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-components.md) - HMDb API > Releases [Variants](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-variants.md) - HMDb API > Releases [Edit History](https://docs.homemediadb.com/api-reference/hm-db-api/releases/release-history.md) - HMDb API > Reviews [Add Review](https://docs.homemediadb.com/api-reference/hm-db-api/reviews/release-reviews-add.md) - HMDb API > Reviews [Edit Review](https://docs.homemediadb.com/api-reference/hm-db-api/reviews/release-reviews-update.md) - HMDb API > Reviews [Delete Review](https://docs.homemediadb.com/api-reference/hm-db-api/reviews/release-reviews-remove.md) - HMDb API > Reviews [Like Review](https://docs.homemediadb.com/api-reference/hm-db-api/reviews/release-reviews-like.md) - HMDb API > Reviews [Unlike Review](https://docs.homemediadb.com/api-reference/hm-db-api/reviews/release-reviews-unlike.md) - HMDb API > Trivia [Add Trivia](https://docs.homemediadb.com/api-reference/hm-db-api/trivia/release-trivia-add.md) - HMDb API > Trivia [Delete Trivia](https://docs.homemediadb.com/api-reference/hm-db-api/trivia/release-trivia-remove.md) - HMDb API > Gallery [Vote on Cover](https://docs.homemediadb.com/api-reference/hm-db-api/gallery/release-gallery-vote.md) - HMDb API > Gallery [Clear Cover Vote](https://docs.homemediadb.com/api-reference/hm-db-api/gallery/release-gallery-unvote.md) - HMDb API > Discs [Details](https://docs.homemediadb.com/api-reference/hm-db-api/discs/disc-by-id.md) - HMDb API > Tapes [Details](https://docs.homemediadb.com/api-reference/hm-db-api/tapes/tape-by-id.md) - HMDb API > Movies [Details](https://docs.homemediadb.com/api-reference/hm-db-api/movies/movie-by-id.md) - HMDb API > Movies [Releases](https://docs.homemediadb.com/api-reference/hm-db-api/movies/movie-releases.md) - HMDb API > Tv [Details](https://docs.homemediadb.com/api-reference/hm-db-api/tv/byid.md) - HMDb API > Tv [Releases](https://docs.homemediadb.com/api-reference/hm-db-api/tv/releases.md) - HMDb API > Franchises [Details](https://docs.homemediadb.com/api-reference/hm-db-api/franchises/franchise-by-id.md) - HMDb API > Franchises [List](https://docs.homemediadb.com/api-reference/hm-db-api/franchises/franchise-list.md) - HMDb API > Distributors [Details](https://docs.homemediadb.com/api-reference/hm-db-api/distributors/distributor-by-slug.md) - HMDb API > Distributors [List](https://docs.homemediadb.com/api-reference/hm-db-api/distributors/distributor-list.md) - HMDb API > Search [Releases](https://docs.homemediadb.com/api-reference/hm-db-api/search/releases.md) - HMDb API > Search [Movies](https://docs.homemediadb.com/api-reference/hm-db-api/search/movies.md) - HMDb API > Search [TV](https://docs.homemediadb.com/api-reference/hm-db-api/search/tv.md) - HMDb API > Search [Franchises](https://docs.homemediadb.com/api-reference/hm-db-api/search/franchises.md) - HMDb API > Search [Distributors](https://docs.homemediadb.com/api-reference/hm-db-api/search/distributors.md) - HMDb API > Find [By Barcode](https://docs.homemediadb.com/api-reference/hm-db-api/find/barcode.md) - HMDb API > Find [By DVD ID](https://docs.homemediadb.com/api-reference/hm-db-api/find/dvdid.md) - HMDb API > Find [By Disc Hash](https://docs.homemediadb.com/api-reference/hm-db-api/find/hash.md) - HMDb API > Discover [Releases](https://docs.homemediadb.com/api-reference/hm-db-api/discover/releases.md) - HMDb API > Stats [Summary](https://docs.homemediadb.com/api-reference/hm-db-api/stats/summary.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.homemediadb.com/openapi.json) - [OpenAPI YAML](https://docs.homemediadb.com/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.homemediadb.com/api-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.homemediadb.com/_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).