Create Folder

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API creates a Folder for the specified entity. It supports the following entities: Semantic Model, Dataset, Dataset Relationship, Workbook, and AI Space.

Method: POST

Request URL: {kyvos-url}/rest/v2/folders

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies media type of request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

Request Body

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
folderName (Required)	String	Name of the Folder to be created.	–
folderId	String	An ID that will be assigned to the Folder being created. If not provided, Kyvos will automatically generate a unique ID.	–
folderType (Required)	String	Type of entity for which the Folder is to be created.	`RDATASET`, `DATASETRELATIONSHIP`, `SMODEL`, `SPACE`, `WORKBOOK`

Responses

200 Success

{
    "folder":[
        {
            "entityType":"WORKBOOK",
            "entitySubType":"",
            "name":"Account folder",
            "privilege":"",
            "id":"folder_17747861614754127031046140817145",
            "userId":"",
            "desc":""
        }
    ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
412	Precondition failed. Parameter missing.
500	Internal Server Error