Docs

DataAgent (OnPremise)

Document Management

Query Documentation

This API is used to call the OpenAPI interface to query documents in the enterprise knowledge engine.

Request Method and Path

Request method: GET
Request URL: {{domain}}/profile_platform/api/v2/rag/document/list?page_size=xx&keywords=xx&kb_id=xx

Request Parameters

Parameter name	Parameter type	Parameter example	Note
page	number	1	Page number
page_size	number	20	Page size
keywords	string	"hello"	Fuzzy match for keywords
kb_id	number	20	ID of the associated knowledge base

Response Parameters

Parameter name	Parameter type	Parameter example	Note
code	number	0	0 -> Success Non-zero -> Failure
msg	string	"success"	If code is non-zero, contains error information
data	RelavantDocument	{}

RelavantDocument

Parameter name	Parameter type	Parameter example	Note
total	number	1	Total number of documents found
page	number	1	Page number
page_size	number	20	Page size
item	List		Document details

Document

Parameter name	Parameter type	Parameter example	Note
name	string	"hello.html"	Document name
kb_id	number	1	ID of the associated knowledge base
token_num	number	10000	Total number of tokens in the document
chunk_num	number	5000	Number of chunks the document is divided into
source_type	string	"lark"	lark - Feishu parsing local - Native parsing
parser_config	Config	{}	Document parsing settings, same as the request parameter 'Config' for "File association with knowledge base"

Request Example

curl 'https://console.volcengine.com/cdp/api/v2/rag/document/list?page=1&page_size=50&keywords=EQE&kb_id=323' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-language: zh-CN,zh;q=0.9' \
  -H 'content-language: cn' \
  -b 'vcloudWebId=caaa960d-aa79-42f8-b610-20bcb16c48f5; monitor_huoshan_web_id=3748351128612115054; monitor_session_id=0711109975673790130; monitor_session_id_flag=1; user_locale=zh; volc_platform_clear_user_locale=1; s_v_web_id=mb4quj0s_UEqGmfK3_07RM_4UU0_8qVI_OnqT8iqP3CSP; signin_i18next=zh; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; connect.sid=s%3Ab090794a-37ba-4011-9e1d-88fe58f04a08.i%2B6ulo4J0W%2B4ANiwKr%2F67MBDRg7r2ZRCTVlnpMwCpwc; userInfo=eyJhbGciOiJSUzI1NiIsImtpZCI6IjViZmU3Y2M2NGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhY2NfaSI6MjEwMDA4OTg4NiwiYXVkIjpbInZvbGNlbmdpbmUiXSwiZXhwIjoxNzUwODM1MTgyLCJpIjoiZDQ2MWQ0NTgtOWZhZi00YmRiLThmNzgtNjBhN2FhNTNhOTQ5IiwiaWRfbiI6IndzbDExMjAxIiwibXNnIjpudWxsLCJzc19uIjoid3NsMTEyMDEiLCJ0IjoiQWNjb3VudCIsInRvcGljIjoic2lnbmluX3VzZXJfaW5mbyIsInZlcnNpb24iOiJ2MSIsInppcCI6IiJ9.iK59lQO8kevghUTkAI_AeZ3qf1TVoOGPxAQTvHBDxr4rEHU-zXHrVUO3UJANaQhEGLJ3Seykw7jAi91E6A3pJPFu3gLezdX6B7sBV5uBI92SlFyMSOlsyaaESp1tXrrl4vkg0Ja2Cd_MimaUE-Otea3qMtE388z73256s0aZkB6fTson-Ax71-w36bcny1PNXFRRIUE-Ns75s8KfYXUE_xvVCXMgqMeK81W3zAo72VPVZ_KhmlaqcXzL_HqLHN1O1wcmntg0oPIfxbWjtMqd7eyxJkVeDFt4IfxrNNj9wvMkW5lC_M5Zo3qmZpPwq6t3YLBDpwPGI5zp7u2u4mdYGQ; login_scene=11; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; csrfToken=b10e639ae00ba2d3093bc81ddbcba493; VOLCFE_im_uuid=1748243184026964694; __tea_cache_tokens_3569={%22web_id%22:%227508647195731183114%22%2C%22user_unique_id%22:%227508647195731183114%22%2C%22timestamp%22:1748249248365%2C%22_type_%22:%22default%22}; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; digest=eyJhbGciOiJSUzI1NiIsImtpZCI6IjZjYmMxNjBhNGJjNDExZWY5NGU2ZThlYmQzMmVlNmUyIn0.eyJhdWQiOlsidm9sY2VuZ2luZSJdLCJleHAiOjE3NDg0MTU5ODIsImlhdCI6MTc0ODI0MzE4MiwiaXNzIjoiaHR0cHM6Ly9zaWduaW4udm9sY2VuZ2luZS5jb20iLCJqdGkiOiJkNDYxZDQ1OC05ZmFmLTRiZGItOGY3OC02MGE3YWE1M2E5NDkiLCJtc2ciOiJINHNJQUFBQUFBQUMvK0tTNFdMeFM4eE5GZUlvTDg0eE5EUXlNSlI0dnZUQ1FUYUZkeUJTeUpDTDNURTVPYjgwcjBSZzNvck5MOW1sNE1xVXdOcTAySkx6YzNQejg3emc0b0FBQUFELy8xM08xeDFSQUFBQSIsIm5hbWUiOiJ3c2wxMTIwMSIsInN1YiI6IjIxMDAwODk4ODYiLCJ0b3BpYyI6InNpZ25pbl9jcmVkZW50aWFsIiwidHJuIjoidHJuOmlhbTo6MjEwMDA4OTg4Njpyb290IiwidmVyc2lvbiI6InYxIiwiemlwIjoiZ3ppcCJ9.dmCfO1MFLVymF4NJnOhauwh9S_xfzJME5LCPrBj6phs-fWg5sts_8Pv3O5bV1vVGS2oOQEuAKpodEIvtwvLKD7Ut3_Xebec0P2e8Xxvxo02aLmXx_z1yEEfmbPGgjfprDV8tpYFkJFInzGTCFRViZaqm7bSBtgDAOFCBpoNfLTVx-pbFOFoZtYdMfRA-KmLFhBahpwGyaWBr_Ixwnq6zsMnXWQpjAAvJVzI0SKW4WBLFYxGTNr9Z8J_50UB_Hgmd2NvezVGnHn_Uq6_kTuJZYachHXD8c4IOwXgRtN83J-7hdEvgwen_SdGsjXKAskJoCJVp_UUeUEjOGQzUmX7tNg; AccountID=2100089886; AccountID=2100089886; monitor_tracing_cookie=[{%22curUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/list%22%2C%22curRenderId%22:%2247964890-c8ae-49be-9b7d-6b761ad16425%22%2C%22targetUrl%22:%22https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge%22%2C%22landingPageUrl%22:%22https://console.volcengine.com/cdp/knowledge-base%22}]' \
  -H 'priority: u=1, i' \
  -H 'referer: https://console.volcengine.com/cdp/knowledge-base/1010249/knowledge/detail?id=323' \
  -H 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "macOS"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \
  -H 'x-org: xx' \
  -H 'x-tenant: xx' \
  -H 'X-User: xx' \
  -H 'Authorization: Bearer xx' \

Response Example

{
    "code": 0,
    "msg": "success",
    "data": {
        "total": 1,
        "page": 1,
        "page_size": 50,
        "items": [
            {
                "create_time": 1747400449824,
                "create_date": "2025-05-16 21:00:49",
                "update_time": 1748251097357,
                "update_date": "2025-05-26 17:18:17",
                "id": 3047,
                "thumbnail": null,
                "kb_id": 323,
                "parser_id": "7505027800571740179",
                "parser_config": {
                    "auto_keywords": 0,
                    "auto_questions": 0,
                    "strategy": 2,
                    "chunk_size": 512,
                    "detect_pdf_table": true,
                    "detect_pdf_img": false,
                    "page_size_limit": 1000,
                    "merge_small_chunks": true,
                    "pdf_with_ocr": true,
                    "doctree_with_outline": true,
                    "to_md": true,
                    "md_collapsed": false,
                    "detect_header": true,
                    "file_trans_timeout": 60,
                    "slides_full_page_as_image": false,
                    "chunk_with_vlm": false
                },
                "source_type": "lark",
                "type": "markdown",
                "created_by": "wsl11201",
                "name": "hello.md",
                "location": "hello.md",
                "size": 969988,
                "token_num": 495135,
                "chunk_num": 5261,
                "progress": 1.0,
                "progress_msg": "Task Process Done!",
                "process_begin_at": "2025-05-16 21:00:53",
                "process_duation": 131.621,
                "run": "3",
                "status": "1"
            }
        ]
    },
    "message": null
}

Last updated: 2026.06.30 11:39:46

DataAgent (OnPremise)

RelavantDocument #

Document #

RelavantDocument

Document