Agents

Search Agent Mentions

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.

post/agent/mention-search

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/agent/mention-search
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

querystring

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

campaign_idstring nullable

Bias results toward one campaign's people and documents.

modestring nullable

Which mention vocabulary to search. Left open rather than closed to a Literal: the app treats an unrecognised mode as 'no filter' instead of an error, so closing it here would turn a working call into a 422.

Response

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.