Runnable endpoint
The <RunnableEndpoint> component lets users make real HTTP requests to your APIs directly from your documentation. It auto-detects the endpoint definition from your API specification, renders a request builder for headers, path parameters, query parameters, and request bodies, and displays the response status, headers, body, and timing inline. Form inputs persist in local storage across page reloads. When AI agents fetch the Markdown version of a page, Fern renders the endpoint definition — method, path, parameters, and request body schema — as structured content, so agents receive the full specification without the interactive form.
Usage
Variants
Collapse by default
Use collapsed to render the component with the form section hidden. Users can expand it by clicking the component.
Properties
The endpoint locator in the format “METHOD /path”. For example: "POST /api/users" or "GET /api/users/{id}". If your API uses namespaces, prefix with the namespace and :: (e.g., "payments::POST /api/users").
Pre-fill the form with a specific example by name. If not specified, the first example is used by default.
Set the default environment for the endpoint. The value must correspond to the x-fern-server-name of a server URL defined in your API specification. If not specified, the first environment is used by default.
Fields to lock by hiding their dropdown selectors. Accepts "environment" to lock the server URL and prevent users from switching environments. When set to readonly={["environment"]}, the environment selector is hidden and the endpoint uses the environment specified by defaultEnvironment (or the first environment if not specified).
Controls whether the component renders collapsed by default with the form section hidden. Set as collapsed={true} or use the shorthand collapsed. Users can expand it by clicking the component.
CSS class name for custom styling of the component container.