You need to enable JavaScript to run this app.
导航
智能问数 API 说明与公共参数
最近更新时间:2025.10.15 14:54:20首次发布时间:2025.04.28 19:57:38
复制全文
我的收藏
有用
有用
无用
无用

概述

本文为您介绍的是智能分析Agent的智能问数功能相关的 Open API,您将了解到如何通过 API 让智能体使用自然语言查询数据。
注意:在您使用本文所述的 API 前,还需完成接入 JWT-Token 和申请 Token 的前置操作及提前配置好智能体,请先了解调用方式,详情可阅读调用方式

API公共参数
  • Context-path: https://{domain}/aeolus/llm/openApi/v2/chatbi/query

  • Path-parameters:

    参数

    类型

    是否必选

    描述

    domain

    string

    • Saas环境 domain: https://console.volcengine.com/bi/datawind
    • 私有化domain: 实际部署的环境域名地址 ${domain}/bi
  • Response:

    {
            "code": "llm/ok",
            "data": [{REULT_OBJECT}],
            "message": {}
    }
    
    • code 状态码, "llm/ok" 表示成功,其他为失败
    • message 成功或失败信息
    • data 结果数据,为一个json object array

API列表

API

说明

查询数据:飞书端

调用OpenAPI接口,使用飞书端的智能分析Agent查询数据。

查询数据:PC端

调用OpenAPI接口,使用PC端的智能分析Agent查询数据。