Overview of the Fern API including usage and authentication

API Overview

API Reference

Overview

Get snippet for endpoint

Load all snippets

Snippets

Generate Token

Revoke Token

Tokens

Human readable api identifier (e.g. venus)

ApiId

EndpointIdentifier

The ID for the endpoint as declared within the IR, this is a unique name for the endpoint, whereas path and
method are not (specifically for the fern definition, consider chat and chat stream). This is optional to
remain backcompat with old snippets of yore.

EndpointMethod

EndpointPath

OrgId

TokenId

AuthPayload

BasicAuthPayload

BearerTokenAuthPayload

CustomSnippetPayload

GoSDK

GoSDKRequest

GoSnippet

JavaSDK

JavaSDKRequest

JavaSnippet

ParameterPayload

PythonSDK

PythonSDKRequest

PythonSnippet

RubySDK

RubySDKRequest

RubySnippet

SDKRequest

Snippet

SnippetsByEndpointMethod

SnippetsPage

TypeScriptSDK

TypeScriptSDKRequest

TypeScriptSnippet

GenerateTokenResponse

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

Aside

Callouts

Accordion Groups

Fern

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	"method": "GET",
7	"path": "/v1/search"
8	}
9	}'

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