Skip to main content
GET
/
v1
/
data
/
schema
Get Table Schema
curl --request GET \
  --url https://api.example.com/v1/data/schema \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "data": {
    "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
        },
        {
          "data_type": {
            "FixedSizeList": [
              {
                "data_type": "Float32",
                "dict_id": 0,
                "dict_is_ordered": false,
                "metadata": {},
                "name": "item",
                "nullable": true
              },
              1024
            ]
          },
          "dict_id": 0,
          "dict_is_ordered": false,
          "metadata": {},
          "name": "embedding",
          "nullable": false
        }
      ],
      "metadata": {
        "active_set_size_limit": "50000",
        "index_info": "[{\"column_id\":\"3\",\"index_type\":\"hnsw\",\"parameters\":{\"M\":\"16\",\"ef_construction\":\"128\",\"space\":\"ipspace\"}}]",
        "table name": "my_table1"
      }
    },
    "table_name": "my_table1"
  },
  "exception": null,
  "success": true
}

Authorizations

Authorization
string
header
required

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

Response

Successfully retrieved the table description

code
integer<int32>
required

HTTP status code.

Required range: x >= 0
success
boolean
required

Whether the request was successful.

data
object
exception
object