Skip to main content
POST
/
v0
/
scrape-jobs
/
bulk
Create multiple scrape jobs
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"
}
'
{
  "created": [
    {
      "url": "https://example.com/docs",
      "scrapeJobId": "123e4567-e89b-12d3-a456-426614174000"
    },
    {
      "url": "https://example.com/guide.pdf",
      "scrapeJobId": "456e7890-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<uri>[]
required

Array of URLs to scrape (1-2000 URLs, max 2048 chars each)

Required array length: 1 - 2000 elements
Maximum string length: 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 jobs created. Contains arrays of successfully created jobs and any failures.

Response after bulk creating scrape jobs

​
created
Bulk Scrape Job Result · object[]
required

Successfully created scrape jobs

Example:
[
  {
    "url": "https://example.com/docs",
    "scrapeJobId": "123e4567-e89b-12d3-a456-426614174000"
  },
  {
    "url": "https://example.com/guide.pdf",
    "scrapeJobId": "456e7890-e89b-12d3-a456-426614174000"
  }
]
​
failed
Bulk Scrape Job Error · object[]
required

Failed scrape job creations

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