Bulk Import from OSS

Bulk import files from an authorized Alibaba Cloud OSS bucket into the data center.

POST

/api/v1/connector/dash/addFilesFromAuthorizedOss

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/connector/dash/addFilesFromAuthorizedOss" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryId": "cate_abc123",
    "categoryType": "UNSTRUCTURED",
    "ossBucket": "my-docs-bucket",
    "ossRegionId": "cn-beijing",
    "fileDetails": [
      {"fileName": "product-guide.pdf", "ossKey": "docs/product-guide.pdf"},
      {"fileName": "faq.docx", "ossKey": "docs/faq.docx"}
    ]
  }'

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

Before use, you must authorize the Bailian platform to access your OSS bucket via a Service-Linked Role (SLR). In the Alibaba Cloud RAM console, confirm that the service-linked role AliyunServiceRoleForBailian has been created; otherwise, the API call will return a permission error.

Authorizations

string

header

required

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

Body

application/json

string

required

类目 ID，通过 listCategory 获取。

enum<string>

default"UNSTRUCTURED"

required

类目类型。

Available options:UNSTRUCTURED,SESSION_FILE

string

required

OSS Bucket 名称。

string

required

OSS 所在地域，如 cn-beijing。

Example:cn-beijing

object[]

required

要导入的文件详情列表。

Required range:items: 1–10

Show child attributes

string

required

导入后的文件名称。

Required range:length: 1–500

string

required

OSS 对象 Key（文件在 Bucket 中的路径）。

Required range:length: 1–256

enum<string>

default"AUTO_SELECT"

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

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

object

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

Show child attributes

enum<string>

视觉解析模型。

Available options:qwen3-vl-plus

string

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

Required range:length: 1–1500

string[]

文件关联的标签列表，最多 10 个。

Required range:items <= 10

boolean

defaultfalse

当 ossKey 对应的文件已存在时是否覆盖，默认 false。

Response

200-application/json

string

响应码，成功时为 Success。

string

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

string

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

object

导入结果。

Show child attributes

string[]

导入成功的文件 ID 列表。

integer

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