Sign in

v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB
queries

Create Query

post/api/v1/queries

Headers

Authorizationstring required

Bearer authentication

Request body

dataset_idstring uuid required
querystring required
type'NATURAL_LANGUAGE' | 'SQL'

All possible query types

parametersobject nullable
embedding_idstring uuid nullable
check_validityboolean
dynamic_tags_versionstring

Response

Successful Response

query_idstring uuid required
querystring required
type'NATURAL_LANGUAGE' | 'SQL' required

All possible query types

status'Queued' | 'Running' | 'Stopping' | 'Stopped' | 'Complete' | 'Error' required

All possible query status values

resultsstring nullable required
start_dtstring date-time nullable
end_dtstring date-time nullable
dataset_idstring uuid required
total_row_countinteger nullable
parametersobject nullable
created_dtstring date-time required
updated_dtstring date-time required
created_user_idstring required
updated_user_idstring nullable