Retrieve

curl --request POST \
  --url https://api.snowleopard.ai/datafiles/{datafile_id}/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userQuery": "How many superheroes are there?"
}
'

{
  "__type__": "retrieveResponse",
  "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": [
    {
      "__type__": "schemaData",
      "schemaId": "<string>",
      "schemaType": "SQLite",
      "query": "<string>",
      "rows": [
        {}
      ],
      "querySummary": {
        "technical_details": "<string>",
        "non_technical_explanation": "<string>"
      },
      "rowMax": 123,
      "isTrimmed": true,
      "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "responseStatus": "SUCCESS"
}

POST

datafiles

{datafile_id}

retrieve

curl --request POST \
  --url https://api.snowleopard.ai/datafiles/{datafile_id}/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userQuery": "How many superheroes are there?"
}
'

{
  "__type__": "retrieveResponse",
  "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": [
    {
      "__type__": "schemaData",
      "schemaId": "<string>",
      "schemaType": "SQLite",
      "query": "<string>",
      "rows": [
        {}
      ],
      "querySummary": {
        "technical_details": "<string>",
        "non_technical_explanation": "<string>"
      },
      "rowMax": 123,
      "isTrimmed": true,
      "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "responseStatus": "SUCCESS"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your auth API key. Create an api_key

Path Parameters

datafile_id

string

required

Unique identifier for the datafile to query

Body

application/json

userQuery

string

required

Natural language query to execute against the Playground datafile

Example:

"How many superheroes are there?"

Response

Successful query execution

__type__

enum<string>

required

Type discriminator

Available options:

retrieveResponse

callId

string<uuid>

required

Unique identifier for this API call

data

(schemaData · object | errorSchemaData · object)[]

required

Array of query results or errors

schemaData
errorSchemaData

Show child attributes

data.__type__

enum<string>

required

Type discriminator

Available options:

schemaData

data.schemaId

string

required

Identifier for the schema/database queried

data.schemaType

string

required

Type of database (e.g. SQLite, PostgreSQL)

Example:

"SQLite"

data.query

string

required

Generated SQL query that was executed

data.rows

object[]

required

Result rows from the query

data.querySummary

object

required

Detailed explanation of the query

Show child attributes

data.querySummary.technical_details

string

Technical explanation of the query logic

data.querySummary.non_technical_explanation

string

Plain language explanation for non-technical users

data.rowMax

integer

required

Maximum number of rows that can be returned

data.isTrimmed

boolean

required

Whether the result set was trimmed due to size limits

data.callId

string<uuid>

Call identifier (optional)

responseStatus

enum<string>

required

Status of the API response

Available options:

SUCCESS,

NOT_FOUND_IN_SCHEMA,

UNKNOWN,

INTERNAL_SERVER_ERROR,

AUTHORIZATION_FAILED,

LLM_ERROR,

LLM_TOKEN_LIMIT_REACHED

Introduction Response

⌘I

Documentation

Endpoints

Authorizations

Path Parameters

Body

Response