Skip to main content
GET
/
crawl
/
{jobId}
/
download
Download Crawl Results as ZIP
curl --request GET \
  --url https://api.spidra.io/api/crawl/{jobId}/download \
  --header 'x-api-key: <api-key>'
"<string>"
Downloads a ZIP archive of all successfully crawled pages from a completed job. Each page is saved as one or more files inside the archive, organized by hostname and path. Use the include parameter to control which content types are bundled in the ZIP.

​
Content Types

ValueWhat is included
htmlRaw HTML file for each page
markdownMarkdown version of each page
dataAI-extracted data in JSON, CSV, or Markdown format (format is auto-detected from your transformInstruction)
If you omit the include parameter, all three types are included by default.

​
Example Requests

# Download everything (HTML, markdown, and extracted data)
curl -OJ "https://api.spidra.io/api/crawl/abc-123/download" \
  -H "x-api-key: YOUR_API_KEY"

# Download only the extracted data
curl -OJ "https://api.spidra.io/api/crawl/abc-123/download?include=data" \
  -H "x-api-key: YOUR_API_KEY"

# Download markdown and data only
curl -OJ "https://api.spidra.io/api/crawl/abc-123/download?include=markdown,data" \
  -H "x-api-key: YOUR_API_KEY"

​
ZIP Archive Structure

When a single content type is requested, files are placed at the root of the archive with appropriate extensions: 
crawl-abc-123.zip
  example.com_blog_post-one.json
  example.com_blog_post-two.json
When multiple content types are requested, each page gets its own folder: 
crawl-abc-123.zip
  example.com_blog_post-one/
    data.json
    index.html
    markdown.md
  example.com_blog_post-two/
    data.json
    index.html
    markdown.md

​
Response

The response is a binary ZIP file with the following headers:
HeaderValue
Content-Typeapplication/zip
Content-Dispositionattachment; filename=crawl-{jobId}.zip
Only pages with status: "success" are included in the download. If no successful pages exist, the API returns a 404 error.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
jobId
string
required

The ID of the completed crawl job to download

Query Parameters

​
include
string

Comma-separated list of content types to include in the ZIP. Accepted values: html, markdown, data. Defaults to all three. Example: include=data,markdown

Response

ZIP archive containing the crawl results

The response is of type file.