Topic Modeling Settings

Read and update per-workspace conversation topic analytics exposure settings.

The topic modeling settings endpoints control whether customer-facing conversation topic analytics are exposed through a workspace's data scope. These settings are restricted to Amigo administrators.

Endpoints

Method	Path	Operation	Description
GET	/v1/{workspace_id}/settings/topic-modeling	get-topic-modeling-settings	Return the current topic analytics exposure setting
PUT	/v1/{workspace_id}/settings/topic-modeling	update-topic-modeling-settings	Enable or disable topic analytics exposure

Get Topic Modeling Settings

GET /v1/{workspace_id}/settings/topic-modeling

Returns the durable desired state for customer conversation topic analytics.

Path Parameters

Parameter	Type	Description
workspace_id	string (UUID)	The workspace identifier

Response

Field	Type	Description
enabled	boolean	Whether conversation topic analytics are exposed for this workspace

Example Response

{
  "enabled": false
}

Update Topic Modeling Settings

PUT /v1/{workspace_id}/settings/topic-modeling

Sets the desired exposure state and schedules an idempotent reconciliation of the workspace's data scope.

Path Parameters

Parameter	Type	Description
workspace_id	string (UUID)	The workspace identifier

Request Body

Field	Type	Required	Description
enabled	boolean	Yes	Whether to enable or disable topic analytics exposure

Example Request

{
  "enabled": true
}

Response

Field	Type	Description
enabled	boolean	The new desired state
reconciliation_status	string	Always "pending" - reconciliation has been queued
run_id	integer	Identifier for the queued reconciliation run

Example Response

{
  "enabled": true,
  "reconciliation_status": "pending",
  "run_id": 12345
}

Authorization

Both endpoints require:

• An API key with workspace update permission
• The caller must be an authenticated Amigo administrator (user principal with an @amigo.ai email)

Non-administrator callers receive a 403 Forbidden response.

Error Responses

Status	Condition
403	Caller is not an Amigo administrator
404	Workspace not found
503	Setting was saved but reconciliation could not be queued (retry the request)