Skip to main content
POST
Crawl API - Stream markdown pages from a website

Authorizations

Authorization
string
header
required

Bearer token authentication using your LLMLayer API key. Include in Authorization header as: Bearer YOUR_LLMLAYER_API_KEY

Body

application/json
url
string<uri>
required

Seed URL to start crawling from

Example:

"https://www.ycombinator.com"

max_pages
integer
default:25

Maximum number of pages to crawl (hard limit: 100)

Required range: 1 <= x <= 100
max_depth
integer
default:2

Maximum depth to crawl from seed URL

Required range: x >= 1
timeout
number | null
default:60

Total timeout in seconds for the entire crawl operation

include_subdomains
boolean
default:false

If true, includes pages from subdomains

Include hyperlinks in extracted content

include_images
boolean
default:true

Include images in extracted content

advanced_proxy
boolean | null
default:false

Enable advanced proxy for protected sites.

main_content_only
boolean | null
default:false

Extract only main page content.

formats
enum<string>[]

Accepted for compatibility; only markdown is currently honored by /api/v2/crawl_stream.

Available options:
markdown
Example:

Response

Server-Sent Events stream of crawled pages

SSE stream with event types: page, usage, done, error