Update Document Metadata in Batch

Update metadata values for multiple documents at once. Each document in the request receives the specified metadata key-value pairs.

POST /datasets/{dataset_id}/documents/metadata

Update Document Metadata in Batch

cURL

curl --request POST \
  --url https://{api_base_url}/datasets/{dataset_id}/documents/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation_data": [
    {
      "document_id": "<string>",
      "metadata_list": [
        {
          "id": "<string>",
          "name": "<string>",
          "value": "<unknown>"
        }
      ],
      "partial_update": false
    }
  ]
}
'

200

{
  "result": "success"
}

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

operation_data · object[] · required

Array of document metadata update operations. Each entry maps a document ID to its metadata key-value pairs.

Show child attributes

Response

200 - application/json

Document metadata updated successfully.

result · string

Operation result.