reference-queries

Create reference query

Create a new reference query for one or more data sources. The query will be enriched with a title and description.

POST /api/v1/reference-queries/

Headers

Authorizationrequired

any - API key authentication using Bearer scheme

Request Body

queryrequired

string

title

string

connection_idrequired

integer - Connection ID this query applies to

source_type

enum<string>: USER, AI, TABLE, - * `USER` - User Provided * `AI` - AI Generated * `TABLE` - Table

Response

idrequired

integer

queryrequired

string

title

string

detailed_descriptionrequired

string

connection_idrequired

integer - Connection ID this query applies to

source_type

enum<string>: USER, AI, TABLE, - * `USER` - User Provided * `AI` - AI Generated * `TABLE` - Table

statusrequired

enum<string>: PROCESSING, ERROR, VALID, TEMPORARY - * `PROCESSING` - Processing * `ERROR` - Error * `VALID` - Valid * `TEMPORARY` - Temporary

error_messagerequired

string

created_atrequired

string<date-time>

last_modifiedrequired

string<date-time>

cURL

curl --request POST \
  --url https://api.camelai.com/api/v1/reference-queries/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "SELECT * FROM orders LIMIT 10",
  "title": "Monthly revenue",
  "connection_id": 123,
  "source_type": "USER"
}'

200

{
  "id": 123,
  "query": "SELECT * FROM orders LIMIT 10",
  "title": "Monthly revenue",
  "detailed_description": "<string>",
  "connection_id": 123,
  "source_type": "USER",
  "status": "PROCESSING",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified": "2023-11-07T05:31:56Z"
}