Get Default Corpus Agent Connection

GET

/api/v2/corpora/{corpus_id}/agents/default

Retrieves the default corpus agent connection for a specified corpus, providing a direct link to the primary agent associated with the corpus.

Path Parameters:

corpus_id: The id of the corpus to get the default agent connection for.

Returns:

The default corpus agent connection for the given corpus id.

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

If the corpus agent connections are not found, the endpoint will return a 404 error.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/corpora//agents/default' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "agent": {
            "id": 0,
            "agent_type": {
                "id": 0,
                "name": "string"
            },
            "instructions": [
                {
                    "id": 0,
                    "instruction": "string",
                    "is_deleted": true,
                    "created_by": "string",
                    "created_on": "2019-08-24T14:15:22Z",
                    "agent": 0
                }
            ],
            "agent_name": "string",
            "domain": "string",
            "prefix_prompt": "string",
            "alias": "string",
            "is_deleted": true,
            "created_by": "string",
            "access": "string",
            "project": 0,
            "llm_config": 0
        },
        "corpus": 0,
        "created_by": "string",
        "is_enabled": true,
        "is_default": true,
        "is_deleted": true,
        "connected_by": 0
    }
}

Get Corpus Agent Connections

Annotate/Tag a Corpus