Smart Q supports open APIs that you can use as needed. This topic introduces the basic information of each API. For detailed information such as parameters and examples of specific APIs, see the documents in the Reference link column.
This feature is currently available only on the China (Hong Kong) and Malaysia sites. Support for other sites will be available soon.
Limits
The XiaoQ OpenAPI is available only in the Professional Edition and higher.
Chat BI embedding
API name | API description | Reference link |
CreateTicket4Copilot | Generates a Smart Q embedding ticket. | |
ModifyCopilotEmbedConfig | Modifies the smart data query embedding configuration. | ModifyCopilotEmbedConfig - Modify smart data query embedding configuration |
QueryCopilotEmbedConfig | Retrieves the configuration list of Smart Q embedding. | QueryCopilotEmbedConfig - Retrieve Smart Q embedding configuration list |
QueryDataRange | Retrieves the timestamp range folder list for the embedding configuration interface. | |
SmartqQueryAbility | Performs smart data queries. |
Intelligent data query management
API name | API description | Reference link |
SmartqAuthorize | Manages smart data query authorizations in batch. | SmartqAuthorize - Batch manage smart data query authorizations |
QueryLlmCubeWithThemeListByUserId | Checks which datasets and analysis subjects a user has data query authorization for. | |
SmartqAuthTransfer | Synchronizes data query permissions from a specified user to other users. | SmartqAuthTransfer - Synchronize data query permissions from a specified user to other users |
QuerySmartqPermissionByCubeId | Checks whether a user has permission for a specific smart data query dataset. | |
QueryDatasetSmartqStatus | Checks whether smart data query is enabled for a dataset. | QueryDatasetSmartqStatus - Check whether smart data query is enabled for a dataset |