Bind Role

Last Updated on : 2026-02-26 09:16:07download

Based on the device ID, bind a role for the AI agent.

API address

POST: /v1.0/cloud/agent/ai/chat/b/devices/{device_id}/role-bindings

Parameter name	Type	IN	Required	Description
device_id	String	path	true	The ID of the specified device.

Description of body

Parameter name	Type	IN	Required	Description
bind_role_type	Integer	body	true	The type of role to bind. Valid values: `0`: Custom role `1`: Template-based role `2`: Single role (There is no role, and data is at the agent level) When `role_id` has a value, this parameter value must be passed.
role_id	String	body	true	The ID of the specified role.

Parameter name	Type	Description
result	boolean	Indicates whether the operation is successful.

POST: /v1.0/cloud/agent/ai/chat/b/devices/{device_id}/role-bindings

{
  "device_id": "6c3585ebfe301b40a8u***",
  "role_id": "94300***",
  "bind_role_type": 1
}

{
    "tid": "6fa034fc1a6d11f0a8212220de940dcb",
    "result": true,
    "t": 1744771778112,
    "success": true
}

For more information, see error code.