Workbench

Run Workbench Provider Scraper

Run a scraper on your connected provider account. CHARGES per result.

auto_enrich DEFAULTS TO TRUE: every result is also enriched and charged unless you turn it off. Quote it with GET /workbench/scraper/providers/{provider}/credit-estimate.

post/workbench/tables/{table_id}/scraper/providers/{provider}/runs

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/scraper/providers/{provider}/runs
  • Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

provider'apify' required

Which scraper provider.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

preset_idstring nullable
custom_actor_idstring nullable
input_configobject
max_resultsinteger
auto_enrichboolean
approved_max_creditsinteger nullable
quote_expires_atstring date-time nullable

Response

Successful Response

dataEnrichmentPayload required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

Changes

No recorded changes to this operation across all 2 revisions of this API.