v1

latestOpenAPI 3.1.0Proprietary2026-07-262570100.1 KB

database-management

Update metadata schema

Add new metadata schema fields to an existing database. Additive only — existing fields cannot be deleted or retyped.

patch/databases/{database}/metadata-schema

Path parameters

databasestring required

Example:acme_corp

Database identifier

Request body

Example request

{
  "add_fields": [
    {
      "data_type": "VARCHAR",
      "enable_analyzer": false,
      "enable_dense_embedding": true,
      "enable_match": true,
      "enable_sparse_embedding": false,
      "max_length": 256,
      "name": "category"
    }
  ]
}

Response

added_fieldsstring[]

Names of the metadata schema fields successfully added.

databasestring

Owning database. Formerly tenant_id; the tenant_id alias is still accepted (deprecated).

tenant_idstring

Example response

{
  "added_fields": [
    "region",
    "summary_label"
  ],
  "database": "acme_corp",
  "tenant_id": "acme_corp"
}