Register File

POST

/api/v1/connector/dash/addFile

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/addFile" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leaseId": "lease_abc123",
    "category": "cate_abc123",
    "categoryType": "UNSTRUCTURED",
    "parser": "AUTO_SELECT",
    "tags": ["产品", "指南"]
  }'

{
  "code": "Success",
  "status_code": 200,
  "data": {
    "fileId": "file_abc123"
  },
  "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

The parameter name for the category ID is category, not categoryId. This differs from other APIs such as listFile and addFilesFromAuthorizedOss, which use the parameter name categoryId. Please take note of this distinction.

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

string

required

上传租约 ID，即 applyFileUploadLease 接口返回的 fileUploadLeaseId。

string

required

类目 ID（注意：此字段名为 category，不是 categoryId），通过 listCategory 获取。可传入 default 使用系统默认类目；categoryType 为 SESSION_FILE 时传入 default 即可。

enum<string>

required

解析器类型，取值见解析器选择表。UNSTRUCTURED 按类目解析设置；SESSION_FILE 不支持更改

Available options:AUTO_SELECT,DOCMIND,DOCMIND_DIGITAL,DOCMIND_LLM_VERSION,DASH_QWEN_VL_PARSER,DOCMIND_LLM_VERSION_MEDIA

enum<string>

default"UNSTRUCTURED"

类目类型，默认 UNSTRUCTURED。UNSTRUCTURED：类目，用于构建知识库；SESSION_FILE：用于智能体应用会话交互的文件。使用 SESSION_FILE 时，applyFileUploadLease 的 categoryType 也须传 SESSION_FILE；此类文件仅当前会话有效，关闭会话后过期（最长 7 天），不支持长期保存。

Available options:UNSTRUCTURED,SESSION_FILE

string[]

文件关联的标签列表，默认为空（不设置标签）。最多传入 100 个标签，所有标签字符长度总和不超过 700，单个标签最多 32 个字符。

Required range:items: 1–100

string

为文件关联一个 URL。构建文档搜索类知识库时系统记录该链接，与智能体应用对话时随该文件召回结果返回（通过 docUrl 字段）。智能体应用须开启知识库并启用“展示回答来源”，否则此参数不生效。

object

解析配置，仅 parser 为 DASH_QWEN_VL_PARSER 时必填，其他解析方式无需传入。

Show child attributes

enum<string>

视觉解析模型。

Available options:qwen3-vl-plus

string

解析提示词，长度 1~1500 字符。

Required range:length: 1–1500

Response

200-application/json

string

响应码，成功时为 Success。

string

错误或提示信息，成功时为空字符串。

string

请求唯一标识，排查问题时请提供此 ID。

object

Show child attributes

string

注册成功后的文件 ID。

string

实际使用的解析器。

string

文件注册状态，成功为 SUCCESS。

integer

业务状态码。成功为 200，参数错误等失败场景为 400。注意失败时 HTTP 状态码仍为 200，需根据本字段与 code 判断结果。