---
title: "Search Agent Mentions"
method: POST
path: "/agent/mention-search"
tags: ["Agents"]
---

# Search Agent Mentions

`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

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- MentionSearchRequest: Mirror of `MentionSearchRequest`.
  - `query` string: Substring to match. Empty - the default - returns the default suggestions rather than nothing, matching the app's own composer.
  - `campaign_id` string, nullable: Bias results toward one campaign's people and documents.
  - `mode` string, 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 `200`

Successful Response

- ApiResponseAgentBenchListPayload
  - `data` AgentBenchListPayload, required: An open envelope for a LIST answer, so a bare list keeps its shape.
    - `items` unknown[]
      - unknown
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)