Get All Agents By Corpus

GET

/v2/api/corpus/{corpus_id}/agent

Retrieves a comprehensive list of agents linked to a specific corpus, allowing users to view and manage agent-corpus associations efficiently.

Purpose:

Provides visibility into all agents that are currently connected to the specified corpus.

Useful for understanding the structure and capabilities of the corpus in terms of assigned agents and their roles.

Functionality:

Accepts a corpus_id as a path parameter.

Returns detailed information for each agent, including metadata such as agent name, domain, instructions, agent type, LLM configuration, access level, and creator details.

Also includes the relationship details such as whether the agent is enabled, deleted, or set as the default for the corpus.

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

Path Params

Header Params

Responses

🟢200OK

application/json

A list of agents associated with the corpus.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/corpus/0/agent' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

[
    {
        "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
    }
]

Check Duplicate Documents

Get Corpus Permissions

Get All Agents By Corpus

How to View Your Corpus ID?#

Request

Responses

How to View Your Corpus ID?