Skip to main content
curl --location 'https://api.zyvik.comv1/crawl' \
--header 'x-zyvik-api-key: zv-<YOUR API KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://docs.zyvik.com",
    "format": "markdown", 
    "maxPages": 1,  
    "concurrent": 5
}'

​
Authentication

​
x-zyvik-api-key
string
required
Header authentication zv-<API KEY>

​
Body

​
url
string
required
Single URL to scrape
​
format
string
default:"markdown"
required
Format for the output response
​
maxPages
integer
required
Maximum pages to crawl
​
concurrent
integer
Number of concurrent connection

​
Response

​
markdown
string
Output response in markdown format
​
metadata
Metadata Object
​
pageScraped
integer
Total scraped page
​
format
string
Output format

​