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.

Path Parameters

patientId*string

Registry key of the patient, as assigned by the caller when the first ingest was submitted.

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

Query Parameters

path?string

Absolute VFS path of the file to read. 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/patient-123/read"
{
  "content": "string"
}
{
  "code": 1,
  "type": "ALREADY_EXISTS",
  "message": "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. Defaults to the root when `path` is omitted. The `patientId` here is the registry key; VFS paths internally use the patient ID extracted from the ingested record.

MCP Tools

Reference for browse_patient, read_patient, search_patient, and get_patient_info.