Get Agent-Corpus Connections

GET

/api/v2/agents/{agent_id}/corpora

Allows retrieving agent-corpus connections filtered by agent id. This endpoint supports pagination and filtering options.

Staging behaviour:

Pass agent_version=staging as a query parameter to fetch the staging version's agent-corpus connections instead of the published agent's.

Query Parameters:

is_enabled: To filter connections based on enabled status.

verbosity: To determine the verbosity of the response. Valid values are "low", "medium", "high". Default is "high".

query: The query to search for corpus names (case-insensitive, optional).

sort_by: Field to sort by (supports 'is_enabled', 'modified_on', 'created_on'). Prefix with '-' for descending. Default is '-is_enabled'.

paginated: To enable pagination. Valid values are "true", "false". Default is "false".

page: The page number to retrieve when pagination is enabled. Default is 1.

items_per_page: Number of items per page when pagination is enabled. Default is 50.

Returns:

JsonResponse with the retrieved agent-corpus connections or error message.

Response structure is consistent:

Non-paginated: {"items": [...], "meta": null}

Paginated: {"items": [...], "meta": {"count": int, "num_pages": int, "current_page": int}}

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200OK

application/json

Success

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//corpora?is_enabled=&items_per_page=&page=&paginated=&query=&sort_by=&verbosity=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "message": "string",
    "success": true,
    "data": {
        "agent_corpus": [
            {
                "id": 0,
                "created_by": "string",
                "modified_by": "string",
                "created_on": "2019-08-24T14:15:22.123Z",
                "modified_on": "2019-08-24T14:15:22.123Z",
                "agent": {
                    "id": 0,
                    "agent_type": {
                        "id": 0,
                        "name": "string"
                    },
                    "instructions": [
                        {
                            "id": 0,
                            "created_by": "string",
                            "modified_by": "string",
                            "created_on": "2019-08-24T14:15:22.123Z",
                            "modified_on": "2019-08-24T14:15:22.123Z",
                            "instruction": "string",
                            "is_deleted": true,
                            "parent": 0,
                            "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": {
                    "id": 0,
                    "indexing_mode": {
                        "id": 0,
                        "mode": "exhaustive"
                    },
                    "name": "string",
                    "description": "string",
                    "owner": {
                        "id": 0,
                        "email": "[email protected]",
                        "is_superuser": true,
                        "first_name": "string",
                        "last_name": "string",
                        "organization": {
                            "id": 0,
                            "org_name": "string"
                        }
                    },
                    "tags": [
                        "string"
                    ]
                },
                "is_enabled": true,
                "is_default": true,
                "is_deleted": true,
                "parent": 0,
                "connected_by": 0
            }
        ]
    }
}

Clone an Agent

Create Multiple Agent-Corpus Connections