Annotate/Tag a Corpus

POST

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

Path Parameters:

corpus_id: The id of the corpus to annotate.

Returns:

A message indicating that the tagging tasks have been queued successfully.

If the user does not have access to the corpus, the endpoint will return a 403 error.

If the corpus is not found, the endpoint will return a 404 error.

If the request object is invalid, the endpoint will return a 400 error.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "Tagging Tasks queued successfully",
    "data": {}
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Get Default Corpus Agent Connection

Get Conversation Starters for a Corpus