Skip to main content
GET
Read VFS.md
Read VFS.md as Markdown for the selected session.
See error examples and recovery steps. The complete OpenAPI contract includes every response schema.

Authorizations

Authorization
string
header
required

The server's token (MIRAGE_AUTH_TOKEN) or a JWT. A daemon in the default local mode with no token accepts requests without one.

Path Parameters

workspace_id
string
required

Workspace ID.

Query Parameters

session_id
string

Session ID to use. If omitted, the default session is used.

profile
string | null

Preview the document as this named profile allows it. Accepted only without session_id.

Response

200 - text/markdown

Generated VFS.md document.

The response is of type string.