Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Code API reference

get

Fetch one available representation of a stable content reference.

Updated
Read as Markdown

Method shoalrun.content.ContentSnapshot.get

get(ref: ContentRef, options: { format: ContentFormat; signal?: AbortSignal; }): Promise<ContentResult>

Fetch one available representation of a stable content reference.

Parameters

Parameter Type / default Description
ref ContentRef Page, section, or named snippet instance in this snapshot.
options { format: ContentFormat; signal?: AbortSignal; } Required format and an optional signal for this read.

Returns

Promise<ContentResult>

Validated representation text with its routing and revision metadata.