Annotate Corpus

POST

/v2/api/corpus/{corpus_id}/annotate

Allows authenticated users to apply annotations to a specific corpus by adding new tags or removing existing ones. This functionality supports the efficient management and classification of corpus data filtering, or search enhancement.

Purpose:

Enables users to organize corpus content by associating meaningful tags.

Functionality:

Accepts corpus_id as a path parameter to identify the target corpus.

Accepts a JSON body containing:

add_tags: An array of new tags to apply to the corpus.

remove_tags: An array of tags to remove from the corpus.

Supports both actions (add/remove) simultaneously in a single request.

How to View Your Corpus ID?

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

For more detailed information about corpus, refer to the Corpus Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/corpus/0/annotate' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "add_tags": [
        "tag 2"
    ],
    "remove_tags": [
        "tag 1"
    ]
}'

Response Example

{
    "status": "success",
    "message": "Corpus is empty. No tasks queued.",
    "task_ids": []
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Corpus successfully annotated.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Get Corpus Permission By User

Trigger a refresh(reindex) of a Corpus

Annotate Corpus

How to View Your Corpus ID?#

Request

Responses

How to View Your Corpus ID?