Update Agent Access

PUT

/v2/api/agent/{agent_id}/access

Overview

This endpoint allows the client to update the access level of a specific agent using its agent_id. Access levels determine who can view, use, or collaborate with the agent in the system.

Functionality

Requires a valid agent_id as a path parameter.

Accepts a JSON payload containing the new access value.

Updates the agent’s access settings and returns the updated data.

Access Levels Explained

The system supports the following predefined access levels:

Only me: Agent is private and only accessible by the owner.

Only team: Agent is visible and usable by members of the same team.

Public: Agent is openly accessible to all authorized users across the platform.

How to Find Your Agent ID

If you're unsure about the agent_id, follow this guide:
How to View Agent ID

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///v2/api/agent/1251/access' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access": "Only me"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Agent Access Data updated successfully",
    "data": {
        "id": 1251,
        "agent_name": "Policy Whisperer",
        "access": "Only team"
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Agent access data updated successfully.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Get Agent Access

Get All Agent Types

Update Agent Access

Overview#

Functionality#