Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spidra.io/llms.txt

Use this file to discover all available pages before exploring further.

The Spidra API gives you programmatic access to web data. All endpoints share a common base URL, authentication scheme, and response format described on this page.

​
Features

Scrape

Extract content from any webpage with browser automation and AI processing.

Batch Scrape

Queue up to 50 URLs in one request and collect per-item results in parallel.

Crawl

Crawl entire websites and extract structured data from every page.

​
Base URL

All API requests use this base URL: 
https://api.spidra.io/api

​
Authentication

Include your API key in the x-api-key header: 
curl -X POST https://api.spidra.io/api/scrape \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": [{"url": "https://example.com"}]}'
Get your API key from app.spidra.io → Settings → API Keys.
Keep your API key secret. Never expose it in frontend code.

​
Response Codes

CodeMeaningWhat it indicates
200OKRequest completed successfully
202AcceptedJob queued. Poll the status endpoint for results
400Bad RequestMissing or invalid parameters in the request body
401UnauthorizedAPI key is missing, invalid, or expired
403ForbiddenCredits exhausted or plan limit reached
404Not FoundThe job or resource does not exist
429Too Many RequestsRate limit hit. Wait and retry with backoff
500Server ErrorSomething went wrong on our end

​
Error Format

All errors return this structure: 
{
  "status": "error",
  "message": "Detailed error explanation"
}