Humanloop Fern Configuration

This repository contains your Fern Configuration:

• OpenAPI spec
• OpenAPI Overrides
• SDK generator config

Setup

npm install -g fern-api # only required once

Validating your API Definition

To validate your API, run:

fern check

Managing Docs

Changing docs

To see a preview of your docs as you write them, run:

fern docs dev

To see a exact preview fully rendered, run:

fern generate --docs --preview

and you'll get a preview URL.

Deploying your Docs

Docs deploy automatically on merge with main.

You can deploy manually if your github handle has been associated with our account on Fern:

fern generate --docs

Managing SDKs

Deploying your SDKs

To deploy your SDKs, simply run the Release Python SDK GitHub Action with the desired version for the release. Under the hood, this leverages the Fern CLI:

npm install -g fern-api # only required once
fern generate --group python-sdk