Skip to content

GET /api/v1/docs/file

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Get File

: markdown content + frontmatter + resolved wikilinks.

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/docs/file" \
-H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: DocFile. Field-level shape: interactive explorer.

DocFile — Successful Response

FieldTypeDescription
bodystring
frontmatterobject
linksarray of WikiLink
pathstring
ParameterInRequiredTypeDefaultConstraintsDescription
pathqueryyesstring——Relative path within vault
CodeMeaningBody
400Requested path is not a .md file—
401Missing or invalid authentication credentialsErrorResponse
403Path escapes the docs vault—
404File not found—
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.