Server-side integration

The InternalLinking.io API returns a list of anchor texts & destination URLs for page, with an optional grouping by module. A grouping may be used to render one block of links in one section of the screen and another elsewhere.

A typical response should resolve within 50 ms. Most customers also cache locally since linking mostly updates daily or weekly. To reduce latency from your side you should keep the connection open for subsequent requests.

If you don't have an API key yet, you can request a new one in the Integration view of your workspace.

You would do a POST request to our endpoint with

• an X_API_KEY header containing the API key
• a User-Agent header indicating your application. For example example corp/1.0 (+https://www.example.com).
• the following body:

    {"url": "https://www.example.com"}

We would respond with a JSON object:

• HTTP 204 and an empty body if there are no links to be shown on the page.
• HTTP 200 if we do have links, and the following body:

{
    "relatedSearches" : [
        {"name": "<anchor text>", "url": "<destination URL>"},
        {"name": "<anchor text>", "url": "<destination URL>"},
        // ...
    ]
}

Questions, features or bugs?

For any questions or support, please feel free to contact us at hello@similar.ai. Alternatively, suggest improvements or new features for our internal linking tool.