Domain name for API request: databuddy.intl.tencentcloudapi.com.
Create a new file (Notebook/SQL/Python, etc.) in the workspace file tree of Studio (unified development IDE), and return the complete meta-information of the file upon success.
Prerequisite
/ for the root directory);.ipynb↔NOTEBOOK_FILE, .sql↔SQL_FILE);A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateFile. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| WorkspaceId | Yes | String | Workspace ID. Source: WorkspaceId returned by the ListWorkspaces API |
| FileName | Yes | String | File name with suffix, up to 255 bytes. It cannot begin or end with . or .., and cannot contain spaces or control characters. |
| ParentFolderPath | No | String | Parent folder path, starting with / and not ending with /. Pass / for the root directory. Source: Path returned by the ListFiles API |
| FileType | No | String | File type. Parameter Value: FILE (regular file/script), NOTEBOOK_FILE (Notebook), SQL_FILE (SQL file). Corresponds to common/domain/entity.proto EntityType |
| FileConfig | No | FileConfig | File operation configuration. |
| BundleId | No | String | Bound BundleId. Source: BundleId returned by the ListBundles API |
| BundleInfo | No | String | Bound BundleInfo, JSON string |
| Storage | No | FileStorage | Initial file content. If not passed, default content will be generated based on FileType. |
| ExtractArchive | No | Boolean | Whether to asynchronously decompress and create ZIP files in Storage. false by default. When true, the async job is fully managed by Workspace throughout its lifecycle, and the response only returns job information through AsyncOperation (FileId is empty). Job progress querying is implemented by the basic platform WS interface and is not defined in this agreement. |
| Parameter Name | Type | Description |
|---|---|---|
| Data | FileInfo | Returned results |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFile
<Common request parameters>
{
"WorkspaceId": "17678671667189298",
"FileName": "test_max_0820_1.ipynb",
"ParentFolderPath": "/Workspace/Users/wedata30-test1@tencent.com@700002164619",
"FileType": "NOTEBOOK_FILE"
}{
"Response": {
"Data": null,
"RequestId": "56f39b22-e3c6-446b-b69f-dc06a4bfb792"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈