Create document

Creates a new document within the workspace (the {workspaceName} in the path is the destination), such as a workbook or dashboard.

POST/organizations/{organizationName}/workspaces/{workspaceName}/documents

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

organizationName*string

The unique identifier of the organization

Match^[a-zA-Z0-9_ -]+$

workspaceName*string

The unique identifier of the destination workspace

Match^(?!.*\*)(?!.*[/]).{1,63}$

Query Parameters

overwrite?boolean

If true, the document will be overwritten if it already exists

moveFrom?string

Optional credible:// URI of a source document to relocate into this workspace (e.g. credible://workspaces/{sourceWorkspace}/documents/{sourcePath}). When set, the source document is moved here under the same path and the request body is ignored. Only data chats and reports may be moved. Not constrained by ResourceIdentifierPattern: the embedded workspace name and document path allow spaces and punctuation (see WorkspaceNamePattern / DocumentPathPattern). The URI is structurally validated by the server (parsed into workspace + document path) and the move is authorized against the resolved source document.

Lengthlength <= 512

Request Body

application/json

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

path?DocumentPathPattern

The file path of the document within the workspace

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

Lengthlength <= 255

content?string

The content of the document, typically Malloy code or configuration

type?string

The type of document, determining its purpose and behavior

Value in

"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

ISO 8601 timestamp indicating when the document was created

Formatdate-time

updatedAt?string

ISO 8601 timestamp indicating when the document was last modified

Formatdate-time

modifiedBy?string

The userId of the user who last modified this document

metadata?

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

Response Body

`application/json`

curl --request POST \  --url 'https://example.com/organizations/string/workspaces/string/documents' \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{}'

{  "path": "string",  "content": "string",  "type": "workbook",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "modifiedBy": "string",  "metadata": {}}

Create document

Authorization

Path Parameters

Query Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`