---
title: "Request a preview"
method: POST
path: "/api/v1/preview"
tags: ["API Reference"]
---

# Request a preview

`POST /api/v1/preview`

## Request

- Base URL: `https://revnu.com`
- URL: `https://revnu.com/api/v1/preview`
- Auth: none required

Research a business's website with no account and no token. Returns a previewId to poll. Capped per caller, per site and per day; a site researched in the last day is reused.

## Request body

- object

## Response `202`

{ previewId, status, poll }. status is researching, or ready when someone previewed the same site in the last day. Poll poll.

- object
  - `previewId` string, required
  - `status` 'failed' | 'ready' | 'researching', required
  - `poll` string, required

## Other responses

- `400`: The body isn't JSON, website is missing or too long, or there is an extra field.
- `422`: invalid_website with a message: the address isn't a public website, the site doesn't exist or isn't answering, it is a social network profile rather than the business's own site, or it is revnu.com.
- `429`: rate_limited with a message. Wait for Retry-After (seconds) before trying again.
- `503`: Something failed on Revnu's side. Honour Retry-After and retry the same call.

---

[API](https://skmtc.dev/revnu/apis/revnu-api.md) · [All operations](https://skmtc.dev/revnu/apis/revnu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/revnu/apis/revnu-api/revisions/52e523c2db61?raw)