You need to enable JavaScript to run this app.
DataAgent (OnPremise)

DataAgent (OnPremise)

Copy page
Download PDF
Enterprise Knowledge Engine
Enterprise Knowledge Engine API Documentation
Copy page
Download PDF
Enterprise Knowledge Engine API Documentation

This document introduces the access domain, access method, common request headers, sample requests, and other related information for the enterprise knowledge engine.

Access domain

{{domain}}/profile_platform/api/v2/rag

Access method

Access via HTTP request method

Common request headers

Request header name

Request header value

Field description

Remarks

x-org

2102067676

Main account ID

x-tenant

2985149

Project ID

Image
Numeric part in the URL

x-user

User ID

Image
Alternatively, log in with the main account. In Knowledge Base - Permission Management, you can also view the sub-account ID.

Authorization

Bearer API_KEY

API KEY authentication

Image
Image

Caution: There is a space between Bearer and API_KEY
Only applications with edit permissions have the publish feature.

Sample request
curl '{{domain}}/profile_platform/api/v2/rag/auth/user' \
  -H "Authorization: Bearer XXX" \
  -H "x-tenant: 1" \
  -H "x-org: 1" \
  -H "content-type: application/json" \
  -H 'x-user: listhida.1'

API list

Functional modules

API

Description

Knowledge base

Create Knowledge Bases

This API is used to call the OpenAPI interface to create a knowledge base in the enterprise knowledge engine.

Update Knowledge Base

This API is used to call the OpenAPI interface to update a knowledge base in the enterprise knowledge engine.

Knowledge Base List

This API is used to call the OpenAPI interface to view the knowledge base list in the enterprise knowledge engine.

Delete Knowledge Bases

This API is used to call the OpenAPI interface to delete a knowledge base in the enterprise knowledge engine.

Create Folders

This API is used to call the OpenAPI interface to create a folder in the enterprise knowledge engine.

Update Folders

This API is used to call the OpenAPI interface to update a folder in the enterprise knowledge engine.

Folder List

This API is used to call the OpenAPI interface to view the folder list in the enterprise knowledge engine.

Upload Files

This API is used to call the OpenAPI interface to upload a file when adding a document in the enterprise knowledge engine.

Knowledge Base for Document Association

This API is used to call the OpenAPI interface to associate a file with a knowledge base when adding a document in the enterprise knowledge engine.

Start Parsing

This API is used to call the OpenAPI interface to start parsing content in the enterprise knowledge engine.

Query Documentation

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

Document management

Document List

This API is used to call the OpenAPI interface to view the document list in the enterprise knowledge engine.

Delete Document

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

Set Document Validity Period

This API is used to call the OpenAPI interface to set the document validity period in the enterprise knowledge engine.

Intelligent conversations

Fetch Session List

This API is used to call the OpenAPI interface to retrieve the conversation list in the enterprise knowledge engine.

Create a Session

This API is used to call the OpenAPI interface to create an intelligent session in the enterprise knowledge engine.

Start a Chat Session

This API is used to call the OpenAPI interface to initiate a chat in an intelligent session in the enterprise knowledge engine.

Retrieve Chat Content in the Session

This API is used to call the OpenAPI interface to retrieve chat records from a session in the enterprise knowledge engine.

Knowledge Base Search

This API is used to call the OpenAPI interface to search the knowledge base in the enterprise knowledge engine.

Chunk management

Chunk Lists

This API is used to call the OpenAPI interface to view the chunk list in the enterprise knowledge engine.

Modify Chunk

This API is used to call the OpenAPI interface to modify the chunk list in the enterprise knowledge engine.

Delete Chunk

This API is used to call the OpenAPI interface to delete the chunk list in the enterprise knowledge engine.

Last updated: 2026.06.30 11:30:56