sites

Add a site to audit; your human completes its checkout

Add a site to audit. A site is the unit of purchase: the answer carries checkout_url, the site's checkout link your human opens to subscribe on Whop (card on file; $79/month per site, billed every 30 days; 3-day free trial on a workspace's first site; later sites are charged at checkout; the answer's billing.trial_offered says which this site's checkout is). Nothing is charged until your human pays, and nothing crawls until then: the first crawl starts by itself when the subscription lands, so do not call crawls_start on an unpaid site. It starts a billing path, so it asks for confirmation: call it with dry_run: true first, then with confirm: true. Hand checkout_url to your human word for word; never open it yourself. Adding a site you already have answers that site (and, while it is unpaid, a fresh checkout). Next: sites_get once your human has paid.

post/v1/sites

Request

  • Base URL: https://frontshelf.io/api
  • URL: https://frontshelf.io/api/v1/sites
  • Auth: HTTP bearer

Request body

urlstring uri required

Any URL on the site; the server keeps its origin (https://example.com).

display_namestring

A label for the site; without one, Frontshelf names it by its title or host.

max_pagesinteger

The most pages one crawl reads (the plan's cap still applies); leave it out for the default budget.

dry_runboolean

true: check the call and say what it would do, without doing it.

confirmboolean

true: go ahead with a change that asks for confirmation.

Response

Add a site to audit; your human completes its checkout

summarystring required

The answer in one or two sentences, with the numbers it rests on.

warningsstring[] required

What limits this answer (a cap, a read that was cut short). Empty when nothing does.

checkout_urlstring nullable required

The site's checkout link (a stable address on Frontshelf that opens Whop's checkout) your human completes to subscribe; null when nothing is owed (billing is off, or the site is already paid).

Changes

No recorded changes to this operation across all 1 revision of this API.