API ReferenceAgentsSQL

Invoke Sql Agent

Beta
Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for the query object.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
configmap from strings to anyRequired
Configuration for the SQL agent including database connection details and query parameters
messageslist of maps from strings to anyRequired
The messages to send to the SQL agent

Response

Successful Response
metadatamap from strings to any
Additional metadata about the generated query
query_asset_idstring
The asset ID of the generated SQL query object

Errors