Workbench

Estimate Workbench Scraper Credits

Price a built-in scraper run. CHARGES NOTHING.

A worst-case quote: what max_results rows would cost, plus the post-scrape enrichment when auto_enrich is set, against the live balance. Nothing is scraped and no credit moves.

The estimate and the run share one costing function on purpose, so the number quoted here is the number the run's own credit gate enforces.

get/workbench/scraper/credit-estimate

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/scraper/credit-estimate
  • Auth: HTTP bearer

Query parameters

table_idstring required

The table the results would land in.

max_resultsinteger required

Ceiling on results the run would return.

auto_enrichboolean

Price the post-scrape enrichment too. Leave false and the quote covers the scrape ALONE - which is the number people misread.

Headers

Authorizationstring nullable
X-Target-Org-Idstring 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.