Overview of the Fern API including usage and authentication

Manage Docs, SDKs, and code snippets using Fern's public-facing API.

API Overview

API Reference

Generate a documentation website for your API

Generate Docs

Get the status of a docs generation request

Get Docs generation status

Docs

Generate an SDK for your API defined at the url provided

Generate SDKs

Get the status of an SDK generation request

Get SDK generation status

SDKs

Get snippet for endpoint

Load all SDK snippets with optional filters

Load all snippets

Snippets

ApiDefinitionId

Human readable api identifier (e.g. venus)

ApiId

DocsConfigId

EndpointIdentifier

EndpointMethod

EndpointPath

OrgId

ApiDefinition

ApiSectionConfiguration

ColorConfig

ColorThemedConfig

ColorsConfiguration

ContentAlignment

DocsApiConfig

The ID of the API. This ID can be referenced in
the navigation configuration.

DocsGenerationStatus

DocsGenerationStatusResponse

DocsNavigationConfig

DocsNavigationItem

DocsTab

The ID of the tab. This ID can be referenced in
the navigation configuration.

DocsUrlConfig

FernDefinition

GenerateDocsResponse

The ID of the generation request. Use this ID to check the status of
the generation request.

HeaderPosition

LayoutConfig

OpenApiSpec

The OpenAPI specification in JSON or YAML format.


PageConfiguration

SectionConfiguration

SidebarOrHeaderPlacement

SingleDocsVersion

TabConfig

CSharpSDKGenerateRequest

The nuget package name for the generated SDK.

The URL to the nuget registry where the package is published.
Defaults to the public nuget registry.

The nuget token to use to publish the package.

DefinitionType

GenerateSDKResponse

GenerationStatusResponse

GoSDKGenerateRequest

The go package name for the generated SDK.

JavaSDKGenerateRequest

The maven artifactId for the generated SDK.

The URL to the maven repository where the package is published.
Defaults to the public maven repository.

The maven username to use to publish the package.

The maven password to use to publish the package.

PythonSDKGenerateRequest

The pypi package name for the generated SDK.

The URL to the pypi registry where the package is published.
Defaults to the public pypi registry.

The pypi token to use to publish the package.

RubySDKGenerateRequest

The ruby gem package name for the generated SDK.

The URL to the ruby gem registry where the package is published.
Defaults to the public ruby gem registry.

The ruby gem token to use to publish the package.

SDKGenerateRequest

SDKGenerationStatus

TypeScriptSDKConfig

Whether to allow custom fetcher for the SDK.
Defaults to false.

Whether to enable validation for the SDK.
Defaults to false.

Whether to bundle the SDK.
Defaults to false.

TypeScriptSDKGenerateRequest

The npm package name for the generated SDK.

The URL to the npm registry where the package is published.
Defaults to the public npm registry.

The npm token to use to publish the package.

CustomSnippetPayload

GoSDK

GoSDKRequest

GoSnippet

JavaSDK

JavaSDKRequest

JavaSnippet

ParameterPayload

PythonSDK

PythonSDKRequest

PythonSnippet

RubySDK

RubySDKRequest

RubySnippet

SDKRequest

Snippet

SnippetsByEndpointMethod

SnippetsPage

TypeScriptSDK

TypeScriptSDKRequest

TypeScriptSnippet

Push any content inside the Aside component to the right of the page in a sticky container

1	curl -X POST https://api.buildwithfern.com/snippets \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"endpoint": {
6	"path": "/v1/search",
7	"method": "GET"
8	}
9	}'

1	<Aside>
2	<EndpointRequestSnippet endpoint='POST /snippets' />
3	</Aside>