Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Get detailed document information, including chunk count and parsing status.
curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/list/index/file/details" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"indexId": "your_index_id",
"pageNumber": 1,
"pageSize": 20
}'{
"code": "Success",
"status_code": 200,
"data": {
"page_number": 1,
"total_count": 1,
"rows": [
{
"chunkSize": 600,
"connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"overlapSize": 100,
"doc_type": "md",
"gmt_modified": 1782184640000,
"doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"categoryName": "Default category",
"separator": " |,|，|。|？|！|\n|\\?|\\!",
"tags": [],
"ingestion_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"size": 21,
"doc_name": "a",
"chunkMode": "auto",
"canDelete": true,
"source_id": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"status": "FINISH"
}
],
"page_size": 1
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}pageNumber, pageSize), unlike other endpoints that use snake_case.DashScope API Key, obtained from the API Key page in the console.
Response code. Success on success.
HTTP status code.
Unique request identifier. Include this ID when reporting an issue.
Show child attributes
Current page number.
Total Documents.
File detail list.
Show child attributes
Unique document identifier.
Document name.
Document type, such as pdf, docx, or txt.
Document processing status: INIT (initialized), PARSING (parsing in progress), PARSE_SUCCESS (parsed), FAIL (failed).
Document size in bytes.
Last modified time (Unix timestamp in milliseconds).
ID of the category the document belongs to.
Name of the category the document belongs to.
ID of the connector the document belongs to.
Data source ID.
Ingestion task ID.
List of document tags.
Whether the document can be deleted.
Chunk size.
Chunk overlap size.
Chunk separator.
Chunking mode.
Whether this file participates in data sync.
Metadata extraction results.
Whether the request succeeded.
Informational message; success on success.
Request status: SUCCESS or FAILED.
curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/list/index/file/details" \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"indexId": "your_index_id",
"pageNumber": 1,
"pageSize": 20
}'{
"code": "Success",
"status_code": 200,
"data": {
"page_number": 1,
"total_count": 1,
"rows": [
{
"chunkSize": 600,
"connectorId": "conn_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"overlapSize": 100,
"doc_type": "md",
"gmt_modified": 1782184640000,
"doc_id": "file_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"categoryName": "Default category",
"separator": " |,|，|。|？|！|\n|\\?|\\!",
"tags": [],
"ingestion_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"size": 21,
"doc_name": "a",
"chunkMode": "auto",
"canDelete": true,
"source_id": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"categoryId": "cate_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxxx",
"status": "FINISH"
}
],
"page_size": 1
},
"success": true,
"message": "success",
"request_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"status": "SUCCESS"
}