Create Query | Coactive AI

curl -X POST https://api.coactive.ai/api/v1/queries \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "dataset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "query": "SELECT * FROM sales WHERE region = \'North America\' AND sale_date >= \'2024-01-01\'"
}'

{
  "query_id": "7b9c9f1e-8d3a-4f2a-9c3e-1a2b3c4d5e6f",
  "query": "SELECT * FROM sales WHERE region = 'North America' AND sale_date >= '2024-01-01'",
  "type": "SQL",
  "status": "Queued",
  "results": "[]",
  "dataset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_dt": "2024-01-15T09:30:00Z",
  "updated_dt": "2024-01-15T09:30:00Z",
  "created_user_id": "user_12345",
  "start_dt": "2024-01-15T09:30:00Z",
  "end_dt": "2024-01-15T09:30:00Z",
  "total_row_count": 0,
  "parameters": {},
  "updated_user_id": "user_12345"
}

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

dataset_idstringRequiredformat: "uuid"

querystringRequired

typeenumOptional

All possible query types

Allowed values:

parametersmap from strings to any or nullOptional

embedding_idstring or nullOptionalformat: "uuid"

check_validitybooleanOptionalDefaults to true

dynamic_tags_versionstringOptionalDefaults to v2

Response

Successful Response

query_idstringformat: "uuid"

querystring

typeenum

All possible query types

Allowed values:

statusenum

All possible query status values

resultsstring or null

dataset_idstringformat: "uuid"

created_dtstringformat: "date-time"

updated_dtstringformat: "date-time"

created_user_idstring

start_dtstring or nullformat: "date-time"

end_dtstring or nullformat: "date-time"

total_row_countinteger or null

parametersmap from strings to any or null

updated_user_idstring or null

Errors

422

Unprocessable Entity Error