Document apiReference

get

Read the full document as an SDDocument structure.

read-onlyidempotent
doc.get(…)

Expected result

Returns an SDDocument with body content projected into SDM/1 canonical shapes, plus the document's authored styles, theme (labeled document or fallback), docDefaults, and diagnostics for missing or unreadable style parts. Paragraph indent *Chars values remain hundredths of a character; numeric distances remain points. Read-model fields do not expand operation-specific authoring support.

Inputs

optionsobject
Fields
includeResolvedboolean
includeProvenanceboolean
includeContextboolean

Result

Output fields
modelVersion"sdm/1"required
bodyunknown[]required
stylesobject
themeobject
Fields
source"document" | "fallback"
colorSchemeobjectrequired
fontSchemeobject
colorSchemeMappingobject
docDefaultsobject
diagnosticsobject[]

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas