Add Or Remove Tags On Document

POST

/v2/api/document/{document_id}/annotate

Allows authenticated users to dynamically manage tags on a specific document by providing its unique document_id. Users can add new tags, remove existing ones, or perform both actions in a single request, making it easier to organize, categorize, and retrieve documents based on relevant topics or keywords.

Purpose:

Enables flexible annotation of documents for improved searchability, filtering, and classification.

Helps maintain a meaningful and up-to-date tagging system as document context evolves.

What is document_id?

document_id is a unique numeric identifier assigned to each document within the system.

It is used to precisely locate and perform operations on a particular document without ambiguity.

How to View Your Document ID?

To find your Document ID, visit the View Document ID Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/document/0/annotate' \
--header 'Ocp-Apim-Subscription-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source": "905f47b8-08db-4e08-8b16-29994194abd0.txt",
    "add_tags": [
        "llama"
    ],
    "remove_tags": [
        "llms"
    ]
}'

Response Example

{
    "status": "success",
    "message": "Tags updated successfully",
    "tags": [
        "llama"
    ]
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Tags added/removed successfully.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Edit Document

Document Polling

Add Or Remove Tags On Document

How to View Your Document ID?#

Request

Responses

How to View Your Document ID?