Create a file

View as MarkdownOpen in Claude
Create an empty workspace, folder, workbook, or report in Sigma. ### Usage notes - Specify a **parentId** for a folder, workbook, or report to place it within another folder. Retrieve the ID to use as a **parentId** by calling the [/v2/files](https://help.sigmacomputing.com/reference/list-files) endpoint and reviewing the `id` field in the response for files with a `type` of `folder`. - Specify an **ownerId** for a folder, workbook, or report to create it on behalf of another user. Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. ### Usage scenarios - **Project onboarding**: Start a new project by creating a workspace and folders to contain the workbooks for the project.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
Workspace detailsobjectRequired
Workspace to create
OR
Folder detailsobjectRequired
Folder to create
OR
Workbook detailsobjectRequired
Workbook to create
OR
Report detailsobjectRequired
Report to create

Response

The response body.
idstring
urlIdstring
namestring
typeenum
parentIdstring
parentUrlIdstring
permissionenum
pathstring
badgestring or null
isArchivedboolean
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
descriptionstring
ownerIdstring or null
parentSourceUrlIdstring

For a document deployed to a tenant organization, the urlId of the source document in the parent organization. Only present when the document was deployed from a parent organization. The source document can be a workbook, template, data model, dataset, or report.