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

DataAgent (OnPremise)

Copy page
Download PDF
Intelligent Data Query(New Version)
Intelligent Data Query API Description and Public Parameters (new version)
Copy page
Download PDF
Intelligent Data Query API Description and Public Parameters (new version)

Overview

This document introduces the Open API related to the smart query feature of the Intelligent Analysis Agent. You will learn how to use the API to enable the agent to query data using natural language.
Caution: Before using the API described in this document, you must complete the preliminary steps of integrating JWT-Token, applying for a Token, and configuring the agent in advance. Please review the invocation method first. For details, refer to Invocation Method.

Caution
  • The new version of the Smart Query OpenAPI does not support invocation from the Lark client. For Lark, it is recommended to directly use the Lark bot to access the smart query feature of the Intelligent Analysis Agent.
  • Before using the new Smart Query interface, ensure that your Intelligent Analysis Agent version is v3.15 or above.

API public parameters
  • Context-path: https://{domain}/bi

  • Path-parameters:

    Parameter

    Type

    Required

    Example value

    Description

    domain

    string

    Yes

    None

    • Private domain: The domain address of the actual deployment environment ${domain}/bi
  • Response:

    {
            "code": "llm/ok",
            "data": [{REULT_OBJECT}],
            "message": {}
    }
    
    • code Status code, "llm/ok" indicates success, others indicate failure
    • message Success or failure information
    • data Result data, which is a JSON object array

API list

Create and retrieve sessions

API

Description

Create a Session

Create session

Retrieve Session Information

Retrieve session information

Update Session

Update session

Session Completion

Chat completion

Retrieve Session Result

Retrieve conversation result

Intelligent data analysis

API

Description

Obtain Available Analysis Capabilities

Retrieve available analysis capabilities

Execute Intelligent Analysis

Execute intelligent analysis

Obtain Analysis Results

Retrieve analysis result

Last updated: 2026.06.02 14:53:15