Skip to content

Search Agent Mentions

POST
/agent/mention-search

Resolve an @-mention: what can be referred to in a message to the agent.

Searches people, campaigns, accounts and documents in one call and returns them with a category, so a composer can render one picker instead of four. A read - it finds things, it changes nothing, and it starts no agent.

A POST only because the filter set is a body. query defaults to empty, which returns the default suggestions rather than nothing, matching the app.

The app publishes the SAME search at /v1/copilot/mention-search from a second router that lazily imports this one’s helpers. One is enough on a versioned contract, and this is the one under /agent, beside the sessions the mentions are typed into.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of MentionSearchRequest.

object
campaign_id
Any of:
string
mode
Any of:
string
query

Substring to match. Empty - the default - returns the default suggestions rather than nothing, matching the app’s own composer.

string
""

Responses

200

Successful Response

object
data
required

An open envelope for a LIST answer, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string