Help Center/ Workspace/ API Reference/ Workspace APIs/ AI Function/ Subscribing to and Unsubscribing from the AI Assistant
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Subscribing to and Unsubscribing from the AI Assistant

Function

Subscribers can use AI-powered capabilities.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:users:subscribeAiAssistant

    Write

    -

    -

    -

    -

URI

POST /v3/users/ai-assistant/subscribe

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

add

No

SubscribeOperationReq object

Request for adding subscriptions. The request must contain a project, user, or user group.

delete

No

SubscribeOperationReq object

Request for deleting subscriptions. The request must contain at least one project, user, or user group.
Table 2 SubscribeOperationReq

Parameter

Mandatory

Type

Description

project

No

project object

Project information.

users

No

Array of CreateSubscribeUserInfo objects

User information list.

usergroups

No

Array of CreateSubscribeUserGroupInfo objects

User group information list.
Table 3 project

Parameter

Mandatory

Type

Description

project_id

No

String

Project ID.
Table 4 CreateSubscribeUserInfo

Parameter

Mandatory

Type

Description

user_id

No

String

User ID.
Table 5 CreateSubscribeUserGroupInfo

Parameter

Mandatory

Type

Description

group_id

Yes

String

User group ID.

Response Parameters

Status code: 200

Subscriber operation response.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_detail

String

Error Details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

POST /v3/users/ai-assistant/subscribe

null

Example Responses

None

Status Codes

Status Code

Description

200

Subscriber operation response.

400

The request cannot be understood by the server due to malformed syntax.

401

Authorization failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: AI Function