Skip to main content
POST
/
v0
/
scrape-jobs
/
bulk
Create a bulk scrape job
curl --request POST \
  --url https://api.avidoai.com/v0/scrape-jobs/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "urls": [
    "https://example.com/docs",
    "https://example.com/guide.pdf",
    "https://example.com/api"
  ],
  "quickstartId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "failed": []
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Body

application/json

Request body for creating multiple scrape jobs at once

​
urls
string[]
required

Array of URLs to scrape (1-2000 URLs, max 2048 chars each). Each URL must be https and resolve to a public host.

Required array length: 1 - 2000 elements
Required string length: 1 - 2048
Example:
[
  "https://example.com/docs",
  "https://example.com/guide.pdf",
  "https://example.com/api"
]
​
quickstartId
string<uuid>

Optional quickstart ID to associate with all scrape jobs

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Bulk scrape job created. Lists any URLs that were rejected by validation or deduplication.

Response after bulk creating scrape jobs

​
failed
Bulk Scrape Job Error · object[]
required

URLs rejected by validation or deduplication. Every other submitted URL landed as a page of the one created scrape job (creation is all-or-nothing).

Example:
[
  {
    "url": "https://invalid-url",
    "error": "Invalid URL format"
  }
]