Skip to main content
POST
/
v1
/
data
/
scan
Scan Data
curl --request POST \
  --url https://api.example.com/v1/data/scan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "filter": "id = '1'",
  "limit": 10,
  "projection": "id, metadata, text"
}
EOF
{
  "code": 200,
  "data": {
    "data": [
      {
        "id": "1",
        "metadata": "{\"file_name\": \"abc.pdf\"}",
        "text": "hello"
      }
    ],
    "schema": {
      "fields": [
        {
          "data_type": "LargeUtf8",
          "dict_id": 0,
          "dict_is_ordered": false,
          "metadata": {},
          "name": "id",
          "nullable": false
        },
        {
          "data_type": "LargeUtf8",
          "dict_id": 0,
          "dict_is_ordered": false,
          "metadata": {},
          "name": "metadata",
          "nullable": false
        },
        {
          "data_type": "LargeUtf8",
          "dict_id": 0,
          "dict_is_ordered": false,
          "metadata": {},
          "name": "text",
          "nullable": false
        }
      ],
      "metadata": {}
    }
  },
  "exception": null,
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Include the token in the Authorization header as 'Bearer '

Body

application/json

The scan condition. It includes projection, filter, and limit.

​
filter
string | null
default:""

SQL WHERE clause to filter the results. If not specified, no filtering will be applied.

Example:

"text like '%hello%'"

​
limit
integer<int32> | null
default:0

Number of rows to return in the result set. If set to 0 or not specified, returns all matching rows.

Example:

"10"

​
projection
string | null
default:*

Columns to include in the result set. Uses SQL projection syntax (e.g. "col1, col2"). If not specified, all columns will be returned.

Example:

"id, metadata, text"

Response

Successfully retrieved the scan results.

​
code
integer<int32>
required

HTTP status code.

Required range: x >= 0
​
success
boolean
required

Whether the request was successful.

​
data
object
​
exception
object