Skip to main content
POST
/
v1
/
table
/
{name}
/
describe
Get Table Details
curl --request POST \
  --url https://{db}.{region}.api.lancedb.com/v1/table/{name}/describe \
  --header 'x-api-key: <api-key>'
{
  "table": "products",
  "version": 5,
  "schema": {
    "fields": [
      {
        "name": "id",
        "type": {
          "name": "int64"
        }
      },
      {
        "name": "name",
        "type": {
          "type": "string"
        }
      },
      {
        "name": "vector",
        "type": {
          "type": "float32",
          "length": 128
        }
      }
    ],
    "metadata": {
      "key": "value"
    }
  },
  "stats": {
    "num_deleted_rows": 150,
    "num_fragments": 12
  }
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
name
string
required

Response

​
table
string
Example:
​
version
integer
Example:
​
schema
object
Example:
​
stats
object