Skip to main content
GET
/
v0
/
scrape-jobs
List all scrape jobs
curl --request GET \
  --url https://api.avidoai.com/v0/scrape-jobs \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123",
      "initiatedBy": "user_123",
      "name": "Documentation Scrape",
      "url": "https://example.com",
      "pages": [
        {
          "url": "https://example.com/page1",
          "title": "Page 1",
          "description": "This is the first page of the documentation.",
          "category": "Documentation"
        },
        {
          "url": "https://example.com/page2"
        }
      ],
      "status": "PENDING"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

limit
integer
default:25

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

Response

Scrape jobs retrieved successfully

Paginated response containing a list of scrape jobs

data
Scrape Job · object[]
required
pagination
object
required

Pagination metadata returned in a paginated response.