Skip to main content
POST
Index a public website

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Headers

X-As-User
string | null

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Body

application/json
url
string
required
Required string length: 1 - 2048
share
enum<string> | null

Visibility for new pages. New websites default to shared; existing websites keep their saved choice.

Available options:
personal,
shared
max_depth
integer
default:3
Required range: 0 <= x <= 5
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

url
string
default:""
status
string
default:queued
discovered
integer | null
default:0
indexed
integer | null
default:0
failed
integer | null
default:0
limit
integer
default:0
limit_reached
boolean
default:false
errors
string[]
duplicates
integer
default:0
run_id
string | null