Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-262570100.1 KB
database-management

Create a database

Create a new database with optional custom metadata schema

post/databases

Request body

databasestring

Database is the canonical v2 name; TenantID is its deprecated alias and remains fully accepted. The TenantAliases middleware reconciles them before this binds, so TenantID is always populated.

embeddings_dimensioninteger

Override for the embedding vector dimension. Default: 1536.

is_embeddings_tenantboolean

Internal flag for embedding-only databases.

tenant_idstring

deprecated: use database

Example request

{
  "database": "acme_corp",
  "database_metadata_schema": [
    {
      "data_type": "VARCHAR",
      "enable_analyzer": false,
      "enable_dense_embedding": true,
      "enable_match": true,
      "enable_sparse_embedding": false,
      "max_length": 256,
      "name": "category"
    }
  ],
  "embeddings_dimension": 1536,
  "tenant_id": "tenant_1234",
  "tenant_metadata_schema": [
    {
      "enable_dense_embedding": true,
      "enable_match": true,
      "max_length": 256,
      "name": "category"
    }
  ]
}

Response

OK

successboolean

Whether the request succeeded.

Example response

{
  "data": {
    "database": "acme_corp",
    "message": "Success",
    "status": "completed",
    "tenant_id": "tenant_1234"
  },
  "error": {
    "code": "DATABASE_NOT_FOUND",
    "message": "Database not found"
  },
  "meta": {
    "collection": "team_docs",
    "database": "acme_corp",
    "deprecation": [
      {
        "deprecated": true,
        "deprecated_field": "tenant_id",
        "deprecated_since": "2.0.1",
        "message": "tenant_id is deprecated; use database instead.",
        "preferred_field": "database"
      }
    ],
    "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
}