For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site-level settings
    • Page-level settings
  • Writing content
    • Markdown basics
    • Rich media in Markdown
    • Fern Editor
    • Reusable snippets
  • AI features
    • Overview
    • Fern Writer
    • AI-generated examples
    • Markdown access
      • Overview
      • Customize LLM output
      • Agent directives
      • Analytics and integration
    • MCP server
    • API catalog discovery
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free
Public API

Algolia search credentials

||View as Markdown|
GET
https://docs.example.com/api/fern-docs/search/v2/key
GET
/api/fern-docs/search/v2/key
$curl https://docs.example.com/api/fern-docs/search/v2/key \
>     -H "FERN_API_KEY: <apiKey>"
1{
2  "appId": "string",
3  "apiKey": "string",
4  "roles": [
5    "string"
6  ]
7}
Get Algolia search credentials for querying documentation.
Was this page helpful?
Previous

JWT from Fern API key

Next

Current user information

Authentication

FERN_API_KEYstring

Fern API key, from fern token.

OR
FERN_TOKENstring
JWT token for this user.

Headers

ROLESstringOptional

Comma-separated list of roles (only with FERN_API_KEY). Sets roles for returned search key if provided, otherwise, roles are empty.

x-fern-hoststringOptional

Documentation domain (required on preview URLs)

Response

Successfully retrieved search credentials
appIdstring
Algolia application ID
apiKeystring

Short-lived Algolia search API key

roleslist of strings

Roles included in the search key (only with FERN_API_KEY auth)

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error