Get Corpus Agent Connections

GET

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

Corporav2

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.

Path Parameters:

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

Returns:

A list of agent connections 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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "corpus_agent_connections": [
            {
                "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
            }
        ]
    }
}

Request

Path Params

corpus_id

integer

required

Corpus ID

Responses

🟢200OK

application/json

Success

Body

success

boolean

required

message

string

required

data

object (CorpusAgentDetailGetResponseSerializer_V2)

required

corpus_agent_connections

array[object (CorpusAgentDetailGet_AgentCorpusCustomSerializer_V2) {8}]

required

🟠400Bad Request

🟠403Forbidden

🔴500Server Error

Delete a Corpus

Get Default Corpus Agent Connection