Create Metadata Field

Create a custom metadata field for the knowledge base. Metadata fields can be used to annotate documents with structured information.

POST /datasets/{dataset_id}/metadata

Error

A valid request URL is required to generate request examples

201

{
  "id": "b5c6d7e8-f9a0-1b2c-3d4e-5f6a7b8c9d0e",
  "name": "author",
  "type": "string"
}

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.

Body

application/json

type · enum<string> · required

string for text values, number for numeric values, time for date/time values.

Available options: string, number, time

name · string · required

Metadata field name.

Response

201 - application/json

Metadata field created successfully.

id · string

Metadata field identifier.

name · string

Metadata field name.

type · string

Metadata field type.