Skip to main content
GET
JavaScript

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.

Query Parameters

url
string
required

The base URL of the website to crawl

max_depth
integer
default:2

Maximum depth of links to follow during crawling

Required range: 0 <= x <= 5
limit
integer
default:20

Maximum number of pages to crawl in total

Required range: 1 <= x <= 100

Response

Successful Response

source
enum<string>
required
Available options:
reddit,
notion,
slack,
google_calendar,
google_mail,
imap,
google_meet,
box,
dropbox,
github,
gitlab,
google_drive,
vault,
web_crawler,
trace,
microsoft_outlook,
microsoft_teams,
granola,
fathom,
fireflies,
figma,
linear,
hubspot,
salesforce,
coda,
confluence,
jira,
metabase,
lightfield,
gong,
pylon,
clickup,
fellow,
odoo,
external_mcp
resource_id
string
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
pending_review,
skipped,
filtered