帮你快速理解、总结文档立即下载
文档中心>大数据智能体工作台 DataBuddy>API 文档>开发工作台(Studio)相关接口>创建代码文件

创建代码文件

最近更新时间：2026-09-14 01:46:28
我的收藏

本页目录：

1. 接口描述

接口请求域名： databuddy.tencentcloudapi.com 。

在Studio（统一开发 IDE）的工作空间文件树中新建一个文件（Notebook/SQL/Python等），创建成功后返回文件的完整元信息。

前置条件

  1. WorkspaceId 对应工作空间存在，且调用方为该工作空间成员；
  2. ParentFolderPath 对应的父文件夹必须存在，且调用方对其有写权限（根目录传 /）；
  3. FileName 在同一父文件夹下不能重名（含后缀比较）；
  4. FileName 后缀必须与 FileType 匹配（.ipynb↔NOTEBOOK_FILE、.sql↔SQL_FILE）；
  5. 需带文件内容创建时通过 Storage 传入（大文件走 COS 中转，小文件放 Storage.Content）。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateFile。
Version 是 String 公共参数，本接口取值：2026-07-15。
Region 是 String 公共参数，详见产品支持的 地域列表。
WorkspaceId 是 String

工作空间 ID。来源：ListWorkspaces 接口返回的 WorkspaceId


示例值：17678671667189298
FileName 是 String

文件名，含后缀，最长 255 字节。不能以 . 或 .. 开头/结尾，不能含空格与控制字符


示例值：test_max_0820_1.ipynb
ParentFolderPath 否 String

父文件夹路径，以 / 开头、末尾不带 /，根目录传 /。来源：ListFiles 接口返回的 Path


示例值：/Workspace/Users/wedata30-test1@tencent.com@700002164619
FileType 否 String

文件类型。取值：FILE（普通文件/脚本）、NOTEBOOK_FILE（Notebook）、SQL_FILE（SQL文件）。对应 common/domain/entity.proto EntityType


示例值：NOTEBOOK_FILE
FileConfig 否 FileConfig

文件运行配置
BundleId 否 String

绑定的 BundleId。来源：ListBundles 接口返回的 BundleId


示例值：create_test
BundleInfo 否 String

绑定的 BundleInfo，JSON 字符串


示例值：{'key1': 'value1'}
Storage 否 FileStorage

文件初始内容。不传则按FileType 生成默认内容
ExtractArchive 否 Boolean 是否将 Storage 中的 ZIP 文件异步解压创建，默认 false。true 时异步作业由 Workspace 负责全生命周期，响应仅通过 AsyncOperation 返回作业信息（FileId 为空）；作业进度查询由基础平台 WS 接口实现，不在本协议中定义。
示例值：false

3. 输出参数

参数名称 类型 描述
Data FileInfo

返回结果


注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建文件示例

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFile
<公共请求参数>

{
    "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"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

中国站