Skip to main content
posthttps://your-instance.example.com/api/parse-website
Request example
Response
posthttps://your-instance.example.com/api/parse-website

Authorization

Authorizationstringheaderrequired#
API key generated from Personal Settings. See Authentication.

Body

application/json
websiteUrlstringrequired#
Root URL to start crawling from
projectTitlestring#
Display name for the project
descriptionstring#
Short description shown in the library list
maxPagesinteger#
Maximum number of pages to crawl

Default: 100

maxDepthinteger#
Maximum link depth from the root URL

Default: 3

excludePatternsstring[]#
URL path patterns to skip (e.g., /blog/*)
forceboolean#
Re-crawl even if already indexed

Default: false

Responses

application/json
Parse job accepted and queued
messagestringrequired#

Example:"Parse queued"

projectstringrequired#
Project identifier assigned to this library (e.g. /your-org/your-repo)

Example:"/your-org/your-repo"

queueIdintegerrequired#
Numeric ID for this parse job

Example:5

positioninteger#
Position in the queue. null if the job started immediately

Example:1