Configure mentions
POST
/api/v1/configure_mentionsFeatures
Use get_mentions to read what the checks found.
Price — $0.00003 per call (twice what serving it costs us), charged to the workspace balance, the same as over MCP.
Also reachable by name at POST /api/v1/tools/configure_mentions.
Input4
Your API key, sent as
Authorization: Bearer dbk_YOUR_API_KEY.Sent from your browser straight to the API — never to Docsbook, never stored.Which engine this arms: ai_overview (Google's AI answer), google or bing (the results page). One of:
ai_overview, google, bing.Whether the daily check runs. Queries are kept either way.
The queries to check, up to 5. Replaces the saved list.
5-field UTC cron for the check. Defaults to a daily early-morning slot.
Output3
Whether the tool itself succeeded. A tool that ran and refused — an exhausted balance, a plan restriction, a bad argument — answers
200 with ok: false: the call was made and billed, and that refusal is its answer.The tool's own JSON answer, already parsed — not a string to parse a second time.
Show child attributes8
ai_overview | google | bing.
As STORED — trimmed, de-duplicated and capped at 5.
null
null
null
null
Server-side wall time for the call.
Limitations
- Choose what the mention checks watch on one engine: turn the daily check on or off, and set the queries (up to 5) — the exact words a reader would type or ask.
- Queries a workspace does NOT rank for are the point: those are the ones Search Console can never report on.
Responses
200The tool ran. Read
ok to see whether it succeeded.401Missing or invalid API key.
Example input
curl -X POST 'https://docsbook.io/api/v1/configure_mentions' \
-H 'Authorization: Bearer dbk_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"surface":"ai_overview"}'Example output
{
"ok": true,
"result": {
"surface": "<surface>",
"enabled": true,
"queries": [],
"cronExpression": "<cronExpression>",
"lastRunAt": "<lastRunAt>",
"lastStatus": "<lastStatus>",
"lastDetail": "<lastDetail>",
"note": "<note>"
},
"duration_ms": 0
}