Workbench

Run Workbench Scraper

Describe what to collect and the scraper fills the table. CHARGES per result, plus enrichment of each when auto_enrich is true.

Quote it first with GET /workbench/scraper/credit-estimate and pass the approved amount as approved_max_credits with quote_expires_at.

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

Request

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

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

promptstring required
max_resultsinteger
modelstring nullable
auto_enrichboolean

Also enrich each scraped row. Charged on top.

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.