Skip to main content
GET
/
v2
/
data
/
schema
Get Table Schema (v2)
curl --request GET \
  --url https://api.example.com/v2/data/schema \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "data": {
    "columns": [
      {
        "name": "id",
        "nullable": false,
        "type": "STRING"
      },
      {
        "name": "metadata",
        "nullable": false,
        "type": "STRING"
      },
      {
        "name": "text",
        "nullable": false,
        "type": "STRING"
      },
      {
        "name": "dense_vector",
        "nullable": false,
        "type": {
          "dim": 4096,
          "element": "FLOAT32",
          "name": "DENSE_VECTOR"
        }
      },
      {
        "name": "sparse_vector",
        "nullable": false,
        "type": {
          "name": "SPARSE_VECTOR"
        }
      }
    ],
    "configurations": {
      "active_set_size_limit": 50000,
      "max_threads": 8
    },
    "indexes": [
      {
        "column": "dense_vector",
        "params": {
          "M": 16,
          "ef_construction": 128,
          "space": "ipspace"
        },
        "type": "diskbased"
      },
      {
        "column": "sparse_vector",
        "params": {
          "sparse_model": "bm25"
        },
        "type": "inverted"
      }
    ],
    "primary_key": [
      "id"
    ],
    "schema": null,
    "segmentation": {
      "buckets": 1,
      "columns": [
        "id"
      ],
      "composition": "single",
      "strategy": "hash"
    },
    "table_name": "14d0508b-c824-4550-8687-f8bdecd9aad1"
  },
  "exception": null,
  "success": true
}

Authorizations

Authorization
string
header
required

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

Response

Successfully retrieved table schema

code
integer<int32>
required

HTTP status code.

Required range: x >= 0
success
boolean
required

Whether the request was successful.

data
object

Table Schema Response

Response containing table schema information including columns, indexes, and configurations.

exception
object

Table Schema Response

Response containing table schema information including columns, indexes, and configurations.