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.
预约演示登录免费开始
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • 变更日志
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
  • 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
预约演示登录免费开始
Public API

Algolia search credentials

||以 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.
此页面是否有帮助？
上一个

JWT from Fern API key

下一个

Current user information

身份验证

FERN_API_KEYstring

Fern API key, from fern token.

OR
FERN_TOKENstring
JWT token for this user.

请求头

ROLESstring可选

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

x-fern-hoststring可选

Documentation domain (required on preview URLs)

响应

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)

错误

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error