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

name of the table

Response

Detailed table information including schema, statistics, and metadata.

The response includes:

  • table: Name of the table
  • version: Latest version number for change tracking
  • schema: Complete Arrow schema with field definitions
  • stats: Performance and storage statistics
​
table
string

Name of the table. Useful for confirming the correct table is being described.

Example:

"products"

​
version
integer

The latest version of the table. Increments with each data modification. Useful for tracking changes and implementing optimistic concurrency control.

Example:

5

​
schema
object

Complete Arrow schema defining the table structure. Includes field names, types, nullability, and metadata.

Example:
{
  "fields": [
    { "name": "id", "type": { "name": "int64" } },
    {
      "name": "name",
      "type": { "type": "string" }
    },
    {
      "name": "vector",
      "type": { "type": "float32", "length": 128 }
    }
  ],
  "metadata": { "key": "value" }
}
​
stats
object

Performance and storage statistics for the table. Useful for monitoring table health and planning operations.