上传文件

上传一个未关联到卷的文件。上传后可通过创建文件将其关联到卷。

POST https://api.moi.matrixorigin.cn/v5/catalog/file/upload

调用前准备

使用 multipart/form-data 请求。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

请求参数

curl -X POST "https://api.moi.matrixorigin.cn/v5/catalog/file/upload" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -F "file=@./orders.csv"

字段

类型

必填

说明

file

file

要上传的本地文件。

成功响应

成功时返回 200file_id。该请求只上传文件,并不将它关联到某个卷。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "file_id": "file-123"
  }
}

字段

类型

说明

code

string

成功时为 OK

msg

string

成功时为 OK

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

字段

类型

说明

file_id

string

上传后生成的文件 ID;可用于创建文件请求。

错误响应

{
  "code": "ErrParamInvalid",
  "msg": "缺少 file 字段",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

错误响应中的附加数据;本示例为 null

后续操作

使用 data.file_id 创建文件将文件关联到卷。

最后更新于