Get detailed document information, including chunk count and parsing status.
Prerequisites
Configure the endpoint and authentication first. See API overview and Authentication.
Endpoint
POST /api/v1/indices/rag/list/index/file/details
Get detailed information about the documents in a specified knowledge base, including chunk count and parsing status.
This endpoint uses camelCase parameters (such as
pageNumber, pageSize), unlike other endpoints that use snake_case.Request body
| Field | Required | Type | Description |
|---|---|---|---|
indexId | Yes | string | Knowledge base ID. |
pageNumber | No | integer | Page number, starting from 1. Default: 1. Note the camelCase naming. |
pageSize | No | integer | Number of documents returned per page. Default: 10. Maximum: 10. |
Request example
BASE_URL is https://{workspace_id}.cn-beijing.maas.aliyuncs.com ({workspace_id} is the workspace ID), and BAILIAN_API_KEY is your Alibaba Cloud Model Studio API key.
Response example
Returns 200 on success.
Response fields
| Field | Type | Description |
|---|---|---|
code | string | Response code. Success on success. |
status_code | integer | HTTP status code. |
request_id | string | Unique request identifier. Provide this ID when troubleshooting. |
data | object | Business data. Sub-fields: page_number (integer, current page number), page_size (integer, current page size, consistent with the request), total_count (integer, total number of documents), rows (array<object>, file detail list. Element fields: doc_id (string, unique document identifier), doc_name (string, document name), doc_type (string, document type, such as pdf, docx, or txt), status (string, document processing status: INIT (initializing), PARSING (parsing), PARSE_SUCCESS (parsed successfully), FAIL (failed)), size (integer, document size in bytes), gmt_modified (integer, last modified time as a millisecond Unix timestamp), categoryId (string, ID of the category), categoryName (string, name of the category), connectorId (string, ID of the connector), source_id (string, data source ID), ingestion_id (string, import task ID), tags (array<string>, document tag list), canDelete (boolean, whether the document can be deleted), chunkSize (integer, chunk size), overlapSize (integer, chunk overlap size), separator (string, chunk separator), chunkMode (string, chunk mode), dataSync (boolean, whether the file participates in data sync), meta_extract_info (array, metadata extraction results)). |
success | boolean | Whether the request succeeded. |
message | string | Message. success on success. |
status | string | Request status: SUCCESS or FAILED. |
Error codes
| HTTP status code | Error code | Message | Description |
|---|---|---|---|
| 400 | Index.InvalidParameter | Required parameter missing or invalid. | Invalid request parameters. |
| 401 | InvalidApiKey | Invalid API-key provided. | Authentication failed. The API key is invalid or missing. |