Suggest internal links

Embed

<a href="https://seolyticize.com/docs/ref-suggest-internal-links"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/480f14c2-beee-43f0-8d9d-7fe19be5650a/social-card.svg?v=3e7ae33eec8b" alt="Suggest internal links" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/suggest_internal_links

Pages that already mention a topic in their text but do not link to the page about it, with the exact sentence and the words to use as the anchor, strongest linking pages first. Give targetUrl (and phrases, default: its title and H1 and the queries it ranks for); without a target, it picks the client's pages in striking distance in Search Console (positions 4–20) — where an internal link moves rankings most. format 'patch' also returns, per page to edit, a unified diff of its HTML or Markdown source (from sources, else the page as served) with the links inserted, and for every link the CMS-ready edit: the words to link, the target and the sentence with the link in it. Answers 'where should we add internal links' and 'give me the edits to make'. Free.

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

crawlIdstring

A crawl id from list_crawls, or "latest" for the newest complete one.

= latest

targetUrlstring

= null

phrasesstring[]

= []

limitinteger

= 10

formatstring

suggestions | patch = suggestions

sourcesobject[]

The linking pages' own source, for diffs against what the CMS stores.

= []

Show child parameters

urlstringrequired

htmlstring

markdownstring

{
  "clientId": "string",
  "crawlId": "latest",
  "targetUrl": null,
  "phrases": [],
  "limit": 10,
  "format": "suggestions",
  "sources": []
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/suggest_internal_links" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","crawlId":"latest","targetUrl":null,"phrases":[],"limit":10,"format":"suggestions","sources":[]}'

TypeScript

Python

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/suggest_internal_links

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/suggest_internal_links

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/suggest_internal_links

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/suggest_internal_links

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/suggest_internal_links

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/suggest_internal_links

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/suggest_internal_links

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 Nov 4, 2026

Was this page helpful?