Skip to main content
GET
Get document details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationName
string
required

The unique identifier of the organization Standard identifier pattern for resource names

Pattern: ^[a-zA-Z0-9_ -]+$
workspaceName
string
required

The unique identifier of the workspace Workspace name pattern. Allows any character except / (would split the FGA resource path — see ResourceIdentifier.parseFromFga) and * (FGA wildcard). 1-63 chars.

Pattern: ^(?!.*\*)(?!.*[/]).{1,63}$
documentPath
string
required

The path to the document within the workspace Document path. Permits alphanumerics, spaces, ASCII hyphen, Unicode en-dash/em-dash (U+2013/U+2014), and common title punctuation (& : , ' + ? ! ( ) $ ^). Bans path traversal (..). Length capped at 255 to match the underlying varchar(255) storage column. % is deliberately excluded because @InitBinder decodes %2F → / in path variables to fix encoded-slash routing, which would collide with any path that legitimately contained '%2F'.

Maximum string length: 255
Pattern: ^(?!.*\.\.)[a-zA-Z0-9_/. \-&:,'+?!()$^–—]+$

Query Parameters

checkAdmin
boolean
default:false

Whether to verify admin privileges for the resource

Response

Document updated successfully

Represents a document within a workspace, such as a workbook or dashboard

path
string

The file path of the document within the workspace

Maximum string length: 255
Pattern: ^(?!.*\.\.)[a-zA-Z0-9_/. \-&:,'+?!()$^–—]+$
content
string

The content of the document, typically Malloy code or configuration

type
enum<string>

The type of document, determining its purpose and behavior

Available options:
workbook,
dashboard,
modeling_chat,
data_chat,
agent_report,
agent_modeling_file,
agent_html_report,
draft_agent_html_report,
draft_agent_report,
draft_package,
model_summary
createdAt
string<date-time>

ISO 8601 timestamp indicating when the document was created

updatedAt
string<date-time>

ISO 8601 timestamp indicating when the document was last modified

modifiedBy
string | null

The userId of the user who last modified this document

metadata
object | null

Optional JSON metadata associated with the document (e.g. title, tags)