---
title: "Submit Scrape Request"
method: POST
path: "/scrape/requests"
tags: ["Scraping"]
---

# Submit Scrape Request

`POST /scrape/requests`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/scrape/requests`
- Auth: HTTP bearer

Ask for a scrape. Returns a job to poll.

Scraping fetches pages from a third party and can cost credits depending on
the adapter - check `GET /scrape/adapters` before running this in a loop.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SubmitScrapeRequest: Ask for a scrape, in plain English. `preview` defaults to TRUE and that default is load-bearing: it holds the run behind a five-row sample so you can see what it will do before it does it at scale. Turning it off is what makes a run expensive.
  - `requirement` string, required: What to scrape, in plain English.
  - `staging_table_id` string, nullable: Staging table to read from and write into.
  - `source_column` string, nullable: Column holding the values to scrape from.
  - `seed_targets` string[], nullable: Cold start: add these as rows in `source_column` before scraping.
  - `row_ids` integer[], nullable: Limit the run to these rows. Omit it to run every row; an empty list is rejected.
  - `adapter` string, nullable: Skip the planner and use this capability directly.
  - `rescrape` boolean: Re-run rows that already have a result.
  - `params` object
  - `preview` boolean: Hold the run behind a 5-row preview. Leave it on for a first run.

## Response `202`

Successful Response

- ApiResponseSettingsPayload
  - `data` SettingsPayload, required: An open envelope for a settings object. Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as "not configured" rather than "we did not tell you".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)