v46

latestOpenAPI 3.0.0MITraw.githubusercontent.com2026-08-0311978417.1 KB
Mentions

Get mention suggestions for a conversation

Get suggestions for mentions (agents and users) based on a query string, scoped to a specific conversation.

get/api/v1/w/{wId}/assistant/conversations/{cId}/mentions/suggestions

Path parameters

wIdstring required

ID of the workspace

cIdstring required

ID of the conversation

Query parameters

querystring required

Search query string to filter suggestions

selectstring[]

Array of mention types to include. Can be "agents", "users", or both. If not provided, defaults to agents and users.

currentboolean

Whether to include the current user in the suggestions.

Response

List of mention suggestions

Example response

{
  "suggestions": [
    {
      "id": "7f3a9c2b1e",
      "type": "agent",
      "label": "My Assistant",
      "pictureUrl": "https://example.com/avatar.png",
      "description": "A helpful AI assistant",
      "userFavorite": true
    }
  ]
}