Annotate a Document

POST

/api/v2/documents/{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.
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.

Path Parameters:

document_id (str): The ID of the document for which to update tags

Request Body:

source (str): The source of the document

add_tags (list): The list of tags to add

remove_tags (list): The list of tags to remove

Returns:

A response with the document tags

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/documents//annotate' \
--header 'Ocp-Apim-Subscription-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source": "string",
    "add_tags": [
        null
    ],
    "remove_tags": [
        null
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "tags": [
            null
        ]
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Delete a Document

Get Conversation Starters for a Document