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

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 starting a new scrape job

​
url
string
required

The URL to scrape. Must be https and resolve to a public host.

Required string length: 1 - 2048
Example:

"https://example.com/docs"

​
quickstartId
string<uuid>

Optional quickstart ID to associate with this 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 created successfully

Response after starting a scrape job

​
id
string<uuid>
required

The unique identifier of the created 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"