Build a comparison page

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-build-comparison-page"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/6e4cd274-9313-4977-8df0-79783ba862a8/social-card.svg?v=3e7ae33eec8b" alt="Build a comparison page" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/build_comparison_page

Plans an honest comparison page — vs (the client against one rival), alternatives (to the first competitor), roundup (best tools in a category) or table — from what each product publishes: its pricing and feature pages (and any sourceUrls) are read and a feature matrix filled, each cell ✅, ⚠️ partial, ❌ or 'Not publicly available' with its source URL, and every price 'as of' the read. Gives the title from the pageType's template, an H1 under 70 characters, a sourced outline of at least 1,500 words with calls to action above the fold, after the table and at the end (never inside a competitor's section), each competitor's strengths acknowledged, the client's product named as the client's, JSON-LD (SoftwareApplication with offers; ItemList in ranked order for roundups; no AggregateRating without real review data) checked against Google's requirements; each product's hidden costs from its pricing page (setup fees, per-user pricing, overages, transaction fees, annual-only billing, minimum seats), a 'Last updated' stamp, related comparisons to link, and checks that the outline carries a methodology section, the hidden costs and related comparisons; and the comparison searches by pattern ('[a] vs [b]', '[a] vs [b] pricing', 'is [a] better than [b]', '[a] alternatives', '[a] alternatives [year]', '[a] review [year]', 'best [category] tools', '[category] comparison'), with demand: true their volumes (one paid keyword-metrics read). Answers 'write a vs page against our rival' and 'what should our alternatives page say'. The outline is one metered Claude call; quote with estimate_cost.

Parameters

Idempotency-Keystringheader
Any unique string, up to 200 characters. A retry with the same key and body is answered from the first answer (Idempotent-Replayed: true) for a day, so it never buys or writes twice; the same key with another body is refused.

Request body

application/json
clientIdstringrequired
pageTypestringrequired
vs | alternatives | roundup | table
competitorsobject[]required
Show child parameters
namestringrequired
domainstringrequired
featuresstring[]
= []
sourceUrlsstring[]
= []
categorystring
For a roundup: what the tools are, e.g. 'CRM'.
= null
demandboolean
= true
instructionsstring
= null
maxCostMicrosinteger
Optional spending limit for this call, in micro-USD (1,000,000 = $1). A purchase that would take the call past it is refused before anything is bought. Pass the estimate from estimate_cost, or what the user agreed to spend.
dryRunboolean
True to buy nothing and get the quote instead: what the call would cost at most and what it would buy.
{
  "clientId": "string",
  "pageType": "vs",
  "competitors": [
    {
      "name": "string",
      "domain": "string"
    }
  ],
  "features": [],
  "sourceUrls": [],
  "category": null,
  "demand": true,
  "instructions": null,
  "maxCostMicros": 0,
  "dryRun": true
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/build_comparison_page" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","pageType":"vs","competitors":[{"name":"string","domain":"string"}],"features":[],"sourceUrls":[],"category":null,"demand":true,"instructions":null,"maxCostMicros":0,"dryRun":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The tool's result under data, and its meta.
Example
{
  "data": {},
  "meta": {
    "requestId": "string",
    "costMicros": 0,
    "cached": true,
    "cachedFrom": "string",
    "dataAsOf": "string",
    "sources": [
      "string"
    ],
    "partial": true,
    "next": [
      {
        "tool": "string",
        "args": {},
        "why": "string"
      }
    ],
    "nextCursor": "string",
    "dryRun": true
  }
}
Schema
datarequired
metaobjectrequired
Beside every answer: what it cost, whether it came from cache, how fresh it is, whether it is complete, and what to call next.
Show child parameters
requestIdstringrequired
costMicrosintegerrequired
Charged by this call, micro-USD (1,000,000 = $1).
cachedbooleanrequired
True when nothing was bought.
cachedFromstring
When the oldest cached answer used was bought.
dataAsOfstring
sourcesstring[]
partialbooleanrequired
True when the data is incomplete: a running crawl, unfinished days, unread pages.
nextobject[]required
Show child parameters
toolstring
argsobject
whystring
nextCursorstring
Pass as cursor for the next page.
dryRunboolean
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
X-Request-Idstring
The id to quote about this request.
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string",
  "code": "string",
  "next": "string",
  "requestId": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
codestring
A stable snake_case reason to branch on; GET /api/v1/errors lists them all.
nextstring
The call or step that fixes it, when there is one.
requestIdstring
Quote it when asking about a failure.
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
401 No key, or a key that is unknown or revoked.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
WWW-Authenticatestring
403 The key's role does not permit the tool, or the key may not reach the named client.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
404 No tool by that name.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
409 A request with this Idempotency-Key is still running.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
429 This key has used its window.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Retry-Afterinteger
Seconds to wait before retrying.
500 The request could not be completed.

Same as 400 · POST /api/v1/tools/build_comparison_page

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Updated