Batch scrape

Scrape up to 1,000 URLs in a single async job. Reserves credits up-front; refunds aren't issued for failed pages.

POST/api/v1/batch-scrape

Request body

FieldTypeDescription
urlsrequiredstring[]1–1000 absolute URLs.
formatsstring[]markdown, html, links.
Default: ["markdown"]
bash
curl https://neuroapi.me/api/v1/batch-scrape \
  -H "Authorization: Bearer $NEUROAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "urls": ["https://a.com", "https://b.com"] }'

Start response

json
{
  "success": true,
  "data": { "id": "550e8400-e29b-41d4-a716-446655440000", "status": "running" },
  "creditsCharged": 2
}

Check status

GET/api/v1/batch-scrape/:id
bash
curl https://neuroapi.me/api/v1/batch-scrape/JOB_ID \
  -H "Authorization: Bearer $NEUROAPI_KEY"

Status response

json
{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "done",
    "pages_processed": 2,
    "credits_charged": 2,
    "result": { "status": "completed", "data": [{ "markdown": "..." }] },
    "created_at": "2026-05-22T15:00:00.000Z",
    "completed_at": "2026-05-22T15:01:00.000Z"
  },
  "creditsCharged": 0
}

Cost: 1 credit per URL reserved on start.