Overview

The Rivl API is designed to find semantically similar companies based on the content of their landing pages.

Base URL

https://api.rivl.ai/v1

Authentication

Authentication is performed via API keys. Your API key should be provided via the **x-api-key** header.

Endpoints

POST /query

Description

Given a domain, find 10 similar companies.

Parameters

**domain** the domain or subdomain you would like like to use as the search term.

**competition** (optional: default true) order results by competition score vs similarity score

Response

**domain** the domain used for the query.

results a map of 10 semantically similar domains and their similarity scores.

Notes

If the search domain is not already present in the database, you will receive a 202 status code. This will trigger a job to add the domain to the database. Most requests take 3 - 5 seconds to complete.

Example