Sign in
docs

Get document

Returns a single document by path.

get/docs/doc

Query parameters

remoteNodestring

name of the remote node

workspacestring

Workspace selector. For list and search APIs, use all, default, or a workspace name. Omitted means all. For document target APIs, use default or a workspace name; omitted means default.

pathstring required

Relative document path (without extension), e.g. runbooks/deploy-guide. Must not start with / or contain ..

Document path (may include slashes for nested docs)

Response

Document details

idstring required
titlestring required
descriptionstring required

Short document description from YAML frontmatter

workspacestring

Workspace that owns this document. Omitted for default documents.

contentstring required

Full file content including YAML frontmatter

filePathstring

Absolute file path of the document on disk

createdAtstring date-time

RFC3339 timestamp when the document was created

updatedAtstring date-time

RFC3339 timestamp when the document was last updated

Changes