API Documentation
Tables
Data
Tables
Describe a table
Describe a table and return Table Information.
POST
/
v1
/
table
/
{name}
/
describe
/
Copy
curl --request POST \
--url https://{db}.{region}.api.lancedb.com/v1/table/{name}/describe/ \
--header 'x-api-key: <api-key>'
Copy
{
"table": "<string>",
"version": 123,
"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": 123,
"num_fragments": 123
}
}
Authorizations
Path Parameters
name of the table
Response
200
application/json
Table information
The response is of type object
.
Copy
curl --request POST \
--url https://{db}.{region}.api.lancedb.com/v1/table/{name}/describe/ \
--header 'x-api-key: <api-key>'
Copy
{
"table": "<string>",
"version": 123,
"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": 123,
"num_fragments": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.