Skip to main content
GET
/
batch
/
scrape
List Batch Jobs
curl --request GET \
  --url https://api.spidra.io/api/batch/scrape \
  --header 'x-api-key: <api-key>'
{
  "jobs": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "totalUrls": 123,
      "completedCount": 123,
      "failedCount": 123,
      "outputFormat": "<string>",
      "scrapingChannel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123
  }
}
Returns a paginated list of all batch jobs for your account, ordered by most recent first. Item-level results are not included. Use GET /api/batch/scrape/{batchId} to fetch those for a specific batch. 
curl "https://api.spidra.io/api/batch/scrape?page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

​
Query Parameters

ParameterTypeDefaultDescription
pagenumber1Page number (1-based)
limitnumber20Jobs per page. Maximum 50

​
Response

{
  "jobs": [
    {
      "uuid": "f3a2b1c0-0000-0000-0000-000000000000",
      "status": "completed",
      "totalUrls": 10,
      "completedCount": 9,
      "failedCount": 1,
      "outputFormat": "json",
      "scrapingChannel": "api",
      "createdAt": "2024-01-15T10:00:00Z",
      "finishedAt": "2024-01-15T10:01:30Z"
    },
    {
      "uuid": "e2c1a0b9-0000-0000-0000-000000000000",
      "status": "running",
      "totalUrls": 25,
      "completedCount": 12,
      "failedCount": 0,
      "outputFormat": "json",
      "scrapingChannel": "api",
      "createdAt": "2024-01-15T10:05:00Z",
      "finishedAt": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 47,
    "totalPages": 3
  }
}

​
Job Entry Fields

FieldTypeDescription
uuidstringBatch ID — use this with other endpoints
statusstringpending, running, completed, failed, or cancelled
totalUrlsnumberHow many URLs were in this batch
completedCountnumberItems that completed successfully
failedCountnumberItems that failed
outputFormatstring"json" or "markdown"
scrapingChannelstring"api" or "playground"
createdAtstringISO 8601 submission timestamp
finishedAtstring | nullISO 8601 completion timestamp, or null if still in progress

​
Pagination Fields

FieldTypeDescription
pagenumberCurrent page number
limitnumberItems per page
totalnumberTotal number of batch jobs for your account
totalPagesnumberTotal pages at the current limit

​
Errors

CodeReason
401Missing x-api-key header
403Invalid or expired API key

Get Batch Status

Fetch full results for a specific batch

Submit a Batch

Start a new batch job

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
default:1

Page number (1-based)

Required range: x >= 1
​
limit
integer
default:20

Number of jobs per page. Maximum 50

Required range: 1 <= x <= 50

Response

Paginated list of batch jobs

​
jobs
object[]
​
pagination
object