Get an Agent

GET

/api/v2/agents/{agent_id}

Retrieves a specific agent by ID, including access control and organization-level visibility checks.

Purpose:

Allows users to fetch detailed information about a single agent by providing its ID.

Validates user access based on agent ownership, organization, and project membership.

Path Parameters:

agent_id (int): The unique identifier of the agent to be retrieved.

Access Control:

If the agent is created by "System", it is accessible to all users.

If the agent is public and the user belongs to the same organization, it is accessible.

If the user is a member of the agent's project or is a superuser, access is granted.

Otherwise, a 403 Forbidden response is returned.

Returns:

A JSON response with the serialized agent data if the agent is found and access is authorized.

A 403 error if the user does not have the required permissions.

A 404 error if the agent is not found.

A 500 error for unexpected server issues.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "created_by": "string",
        "modified_by": "string",
        "created_on": "2019-08-24T14:15:22.123Z",
        "modified_on": "2019-08-24T14:15:22.123Z",
        "user": {
            "id": 0,
            "email": "[email protected]",
            "first_name": "string",
            "last_name": "string",
            "organization": 0
        },
        "agent_type": {
            "id": 0,
            "created_by": "string",
            "modified_by": "string",
            "created_on": "2019-08-24T14:15:22.123Z",
            "modified_on": "2019-08-24T14:15:22.123Z",
            "name": "string",
            "description": "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,
                "agent": 0
            }
        ],
        "project": {
            "id": 0,
            "project_name": "string"
        },
        "connected_tool_names": [
            "string"
        ],
        "tags": [
            "string"
        ],
        "character_voice": {
            "id": 0,
            "voice_name": "string",
            "voice_identifier": "string",
            "gender": "male"
        },
        "pattern": {
            "id": 0,
            "name": "string",
            "description": "string"
        },
        "agent_name": "string",
        "industry_area": "string",
        "domain": "string",
        "sample_q1": "string",
        "sample_q2": "string",
        "sample_q3": "string",
        "sample_q4": "string",
        "prefix_prompt": "string",
        "alias": "string",
        "is_active": true,
        "is_deleted": true,
        "agent_image": "string",
        "access": "string",
        "status": "string",
        "caching_enabled": true,
        "chunk_count": -2147483648,
        "attachment_chunk_count": -2147483648,
        "attachment_chunking": true,
        "react_enabled": true,
        "react_max_iteration_count": -2147483648,
        "reasoning_mode": "react",
        "call_enabled": true,
        "is_published_as_teammate": true,
        "chat_count": -2147483648,
        "likes_count": -2147483648,
        "conversation_starter_enabled": true,
        "enable_embed": true,
        "llm_config": 0,
        "cloned_from": 0
    }
}

Create a new Agent

Update an Agent