DocsAPI ReferenceExport crawl results
GET/v1/crawl/:id/export

Export crawl results

Downloads all pages from a completed crawl job in the requested format. CSV includes url, title, and markdown columns. XML wraps each page with CDATA to preserve special characters. ZIP contains one .md file per page named by URL slug.

Query parameters

NameTypeRequiredDescription
idstringrequiredCrawl job ID
formatstringoptionaldefault: "csv""csv" | "xml" | "zip"

Example

bash
curl "http://localhost:3000/v1/crawl/c3d4e5f6-.../export?format=zip" -o results.zip

Response

bash
(binary file download — Content-Type varies by format)
csv  → text/csv
xml  → application/xml
zip  → application/zip

Try it

Live preview only works when the API is running on your machine.

Run docker compose up and the Try-It panel will become interactive. Until then, copy the curl example below.