Import from OSS

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 using this endpoint, grant Alibaba Cloud Model Studio access to your OSS bucket via a Service Linked Role (SLR). Confirm in the Alibaba Cloud RAM console that the AliyunServiceRoleForBailian SLR has been created — otherwise the call returns a permission error.

Authorizations

string

header

required

DashScope API Key, obtained from the API Key page in the console.

Body

application/json

string

required

Category ID. Returned by listCategory.

enum<string>

default"UNSTRUCTURED"

required

Category type.

Available options:UNSTRUCTURED,SESSION_FILE

string

required

OSS bucket name.

string

required

OSS region, for example cn-beijing.

Example:cn-beijing

object[]

required

Files to import.

Required range:items: 1–10

Show child attributes

string

required

File name after import.

Required range:length: 1–500

string

required

OSS object key (path of the file in the bucket).

Required range:length: 1–256

enum<string>

default"AUTO_SELECT"

Parser type. AUTO_SELECT picks a parser automatically; DOCMIND intelligent document parsing; DOCMIND_DIGITAL digital document parsing; DOCMIND_LLM_VERSION LLM-based document parsing; DASH_QWEN_VL_PARSER Qwen VL parsing (requires parserConfig); DOCMIND_LLM_VERSION_MEDIA audio and video parsing. When categoryType is UNSTRUCTURED, files are parsed according to the category's data parsing settings; when it is SESSION_FILE, the system uses its default parsing method, which cannot be changed.

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

object

Parser configuration. Required only when parser is DASH_QWEN_VL_PARSER; not needed for other parsers.

Show child attributes

enum<string>

Visual parsing model.

Available options:qwen3-vl-plus

string

Parsing prompt, 1 to 1500 characters.

Required range:length: 1–1500

string[]

Tags associated with the files. Up to 10 tags.

Required range:items <= 10

boolean

defaultfalse

Whether to overwrite an existing file with the same ossKey. Defaults to false.

Response

200-application/json

string

Response code. Success on success.

string

Error or informational message; an empty string on success.

string

Unique request identifier. Include this ID when reporting an issue.

object

Import result.

Show child attributes

string[]

IDs of the successfully imported files.

integer

Business status code. 200 on success, 400 for failures such as invalid parameters. Note that the HTTP status code remains 200 even on failure, so rely on this field and code to determine the result.