Skip to main content
GET
Read a workspace file's text

Authorizations

Authorization
string
header
required

Workspace-scoped Dench API key from workspace settings. This is the same key used by DENCH_API_KEY in sandboxes.

Query Parameters

path
string
required

Workspace file path, e.g. /reports/q2.md. A leading /workspace/ mount prefix is stripped.

slug
string

Response

object | null

Successful response

The file, or null when nothing exists at the path.

path
string
required
isDir
boolean
required
virtual
boolean
required
size
number | null
required
content
string | null
required

Inline text, or null for binary / uncached files.

encoding
string | null
required
downloadable
boolean
required
mtime
number | null
contentHash
string | null
{key}
any