Skip to main content
POST
/
v0
/
scrape-jobs
/
{id}
/
start
Start scraping all pages of a scrape job
curl --request POST \
  --url https://api.avidoai.com/v0/scrape-jobs/{id}/start \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "pageCount": 10
}

Documentation Index

Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt

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

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

​
id
string<uuid>
required

The unique identifier of the scrape job

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

Scrape job started successfully

Response after starting all pages scrape

​
pageCount
integer
required

The total number of pages scraped

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10