result = client.databases.get_metadata_schema(database="acme_corp")
const result = await client.databases.getMetadataSchema({ database: "acme_corp" });
curl 'https://api.hydradb.com/databases/acme_corp/metadata-schema' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"database": "acme_corp",
"fields": [
{
"data_type": "VARCHAR",
"enable_dense_embedding": true,
"enable_match": true,
"enable_sparse_embedding": false,
"max_length": 256,
"name": "category"
}
],
"tenant_id": "acme_corp"
},
"error": null,
"meta": {
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234"
},
"success": true
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Databases
Get Metadata Schema
Read the metadata fields declared for a database.
GET
/
databases
/
{database}
/
metadata-schema
result = client.databases.get_metadata_schema(database="acme_corp")
const result = await client.databases.getMetadataSchema({ database: "acme_corp" });
curl 'https://api.hydradb.com/databases/acme_corp/metadata-schema' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
{
"data": {
"database": "acme_corp",
"fields": [
{
"data_type": "VARCHAR",
"enable_dense_embedding": true,
"enable_match": true,
"enable_sparse_embedding": false,
"max_length": 256,
"name": "category"
}
],
"tenant_id": "acme_corp"
},
"error": null,
"meta": {
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234"
},
"success": true
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}{
"data": "<unknown>",
"detail": {
"deprecated": true,
"deprecated_field": "tenant_id",
"error_code": "VALIDATION_ERROR",
"message": "Request validation failed",
"preferred_field": "database"
},
"error": {
"code": "DATABASE_NOT_FOUND",
"message": "Database not found"
},
"meta": {
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d"
},
"success": false
}Returns the database’s declared metadata fields in
The field definitions have the same shape accepted by Create Database and Update Metadata Schema. Free-form
data.fields, including each field’s type and search settings. Use it to check which fields you can send in metadata before ingesting or updating context.
result = client.databases.get_metadata_schema(database="acme_corp")
const result = await client.databases.getMetadataSchema({ database: "acme_corp" });
curl 'https://api.hydradb.com/databases/acme_corp/metadata-schema' \
-H "Authorization: Bearer $HYDRA_DB_API_KEY" \
-H "API-Version: 2"
additional_metadata fields are not part of this schema.
Related resources
- Update Metadata Schema: add fields
- Metadata guide: declare and filter metadata
Authorizations
Send your API key as Authorization: Bearer <your_api_key>.
Path Parameters
Database whose metadata schema to read.
Example:
"acme_corp"
Response
OK
Show child attributes
Show child attributes
Example:
{
"database": "acme_corp",
"fields": [
{
"data_type": "VARCHAR",
"enable_dense_embedding": true,
"enable_match": true,
"enable_sparse_embedding": false,
"max_length": 256,
"name": "category"
}
],
"tenant_id": "acme_corp"
}
Error details on failure, or null on success.
Show child attributes
Show child attributes
Example:
null
Show child attributes
Show child attributes
Example:
{
"collection": "team_docs",
"database": "acme_corp",
"latency_ms": 12.3,
"request_id": "9d13aef4-02f4-4e73-8c62-4c2601d04f9d",
"source_type": "file",
"sub_tenant_id": "sub_tenant_4567",
"tenant_id": "tenant_1234"
}
Whether the request succeeded.
Example:
true
Was this page helpful?