创建 SQL 工作簿¶

创建一个用于保存 SQL 内容及其版本的工作簿。成功后，响应返回工作簿 ID，用于创建和管理版本。

POST https://api.moi.matrixorigin.cn/v5/workbook/create

调用前准备¶

准备有目标工作区访问权限且具有创建工作簿权限的个人访问令牌和目标工作区 ID。

请求体¶

将 $AI_STUDIO_API_KEY、$WORKSPACE_ID 和 $WORKBOOK_NAME 替换为实际值。

输入示例

curl -X POST "https://api.moi.matrixorigin.cn/v5/workbook/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"name\": \"$WORKBOOK_NAME\"
  }"

参数说明

参数	类型	是否必填	说明
`name`	string	是	SQL 工作簿名称。

成功响应¶

响应返回新建 SQL 工作簿的 ID。记录该 ID 后，可以创建草稿版本。

响应示例

{
  "code": 200,
  "data": {
    "workbook_id": "workbook-123",
    "name": "销售分析"
  }
}

字段说明

通用字段

字段	类型	说明
`code`	integer	成功时为 `200`。
`data`	object	新建工作簿的信息。

工作簿信息

下面表格展开响应示例中的 data 对象；每一行是该对象的一个字段。

字段	类型	说明
`workbook_id`	string	新建 SQL 工作簿的 ID。
`name`	string	SQL 工作簿名称。

错误响应¶

响应示例

{
  "code": 400,
  "message": "请求参数无效"
}

字段说明

字段	类型	说明
`code`	integer	错误状态码。
`message`	string	错误信息。

后续操作¶

记录工作簿 ID 后，可创建 SQL 草稿版本或查看 SQL 工作簿版本列表。

最后更新于 2026 年 9 月 28 日