Launch an information gain analysis on a guide
Réservé : en test, accès sur invitation. Reserved feature, in test, access by invitation. Accounts without access receive 403 FEATURE_NOT_AVAILABLE.
Answers the question "what is missing from my text to bring more than the top results, and where?". The analysis reads the competing pages of the guide's Google results, extracts the facts they state (each with a verbatim excerpt), groups them, checks which ones the guide text states (covered, partial or absent), and lists information gain leads found beyond the top results plus first-hand questions only the author can answer.
When to call it. Once per guide, or again after the competing pages changed. To check an edited text against an existing analysis, call recheck_information_gain_coverage instead (about 10 seconds, no competitor is read again).
The analysis is asynchronous and takes 30 to 60 seconds. Wait about 30 seconds, then call get_information_gain (view=summary, the default) every 10 seconds until status is done or failed. Read view=summary first; ask for view=full only if the whole matrix is needed.
htmlContent is optional. When given, the guide column is checked against this HTML (send the text as displayed, without mark tags); when omitted, the text saved in the guide is used. htmlContent is limited to 2,000,000 bytes (UTF-8) through the API, and to about 1 MB through the MCP server (the size of the whole MCP request).
Costs 60 tokens, charged when the analysis is launched (202, the body carries tokensCharged). Nothing is charged when the call is refused before the launch is attempted (invalid input, 403, 404, or 409 ANALYSIS_RUNNING for an analysis already running). When the launch itself fails after the charge, whatever the status, the tokens are given back before the response and the body carries refunded (true when the credit is on the ledger, false when the refund failed and is logged for a manual replay). When an accepted analysis ends failed, its tokens are given back at the first read that sees it (get_information_gain), whose response then carries refunded and refundedTokens.
Request
- Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
- URL: https://app.serpmantics.com/api/v1/information-gain
- Auth: HTTP bearer
Request body
Example request
{
"guideId": "507f1f77bcf86cd799439011",
"htmlContent": "<h1>Title</h1><p>My article...</p>"
}Response
Analysis launched. Poll pollUrl (or call get_information_gain) until status is done or failed.
Example response
{
"success": true,
"data": {
"analysisId": "6ad076f5848df4b18fb3d71e",
"status": "pending",
"pollUrl": "/api/v1/information-gain?guideId=507f1f77bcf86cd799439011&view=summary",
"tokensCharged": 60
}
}Changes
No recorded changes to this operation across all 1 revision of this API.