List Metadata Fields

Returns the list of all metadata fields (both custom and built-in) for the knowledge base, along with the count of documents using each field.

GET /datasets/{dataset_id}/metadata

Error

A valid request URL is required to generate request examples

200

{
  "doc_metadata": [
    {
      "id": "b5c6d7e8-f9a0-1b2c-3d4e-5f6a7b8c9d0e",
      "name": "author",
      "type": "string",
      "count": 3
    }
  ],
  "built_in_field_enabled": true
}

Authorizations

Authorization · string · header · required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

dataset_id · string<uuid> · required

Knowledge base ID.

Response

200 - application/json

Metadata fields for the knowledge base.

doc_metadata · object[]

List of metadata field definitions.

Show child attributes

built_in_field_enabled · boolean

Whether built-in metadata fields are enabled for this knowledge base.