Skip to main content
POST
/
parse-website
Parse a website
curl --request POST \
  --url https://your-instance.example.com/api/parse-website \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "websiteUrl": "https://docs.example.com",
  "maxPages": 50
}
'
{
  "message": "Parse queued",
  "project": "/your-org/your-repo",
  "queueId": 5,
  "position": 1
}

Authorizations

​
Authorization
string
header
required

API key generated from Personal Settings. See Authentication.

Body

application/json
​
websiteUrl
string<uri>
required

Root URL to start crawling from

​
projectTitle
string

Display name for the project

​
description
string

Short description shown in the library list

​
maxPages
integer
default:100

Maximum number of pages to crawl

​
maxDepth
integer
default:3

Maximum link depth from the root URL

​
excludePatterns
string[]

URL path patterns to skip (e.g., /blog/*)

​
force
boolean
default:false

Re-crawl even if already indexed

Response

Parse job accepted and queued

​
message
string
required
Example:

"Parse queued"

​
project
string
required

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

Example:

"/your-org/your-repo"

​
queueId
integer
required

Numeric ID for this parse job

Example:

5

​
position
integer | null

Position in the queue. null if the job started immediately

Example:

1