Clinia
API ReferenceREST API

Read VFS path

GET
/v1/patients/{patientId}/read

Returns the content of a VFS file at the given path. Three output formats are supported: narrative (full Markdown, default), compact (condensed Markdown), and structured (machine-readable JSON). Use token_budget to cap approximate output length in tokens.

Authorization

Bearer read
AuthorizationBearer <token>

Each operation lists the OAuth scope (read or write) it requires.

In: header

Scope: read

Path Parameters

patientId*string

ID of the patient

Match^[A-Za-z0-9._-]{1,128}$

Query Parameters

path?string

VFS path of the file to read, relative to the patient root (e.g. /conditions/active). Defaults to the root when omitted.

Default""
format?string

Output format. narrative (default) returns full Markdown; compact returns condensed Markdown; structured returns machine-readable JSON.

Default"narrative"

Value in

  • "narrative"
  • "structured"
  • "compact"
token_budget?integer

Approximate token budget for the response

Range0 < value

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/patients/string/read"
{  "content": "string"}

Browse VFS GET

Lists the contents of a VFS path. Returns directory children with name, type, and preview, or file content when the path resolves to a file. Paths are relative to the patient root (e.g. `/conditions/active`); the patient is identified by the `patientId` route param. Defaults to the root when `path` is omitted.

MCP Tools

Reference for browse_patient, read_patient, search_patient, and get_patient_info.