Algolia search credentials

Get Algolia search credentials for querying documentation.

Authentication

FERN_API_KEYstring

Fern API key, from fern generate 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 or null

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

Errors