Run extraction
run_extractionStarts an asynchronous extraction run using a saved extraction ID, filling placeholder variables to collect records from the source. Poll the run or provide a webhook URL to retrieve the JSON results.
Instructions
run extraction
Execute a ready extraction. Returns a run — poll GET /runs/{id} and fetch the extracted records with GET /runs/{id}/result (the records come back as an array of JSON objects matching your schema), or pass a webhook_url.
variables fills any {{ placeholder }} values the plan defines (e.g. a search term or location). Each run charges run credits (credits_charged).
Workflow: Starts an async extraction run. Poll get_run, then fetch the records with get_run_result.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The extraction id (ext_...) | |
| variables | No | Values for the plan's placeholders | |
| max_credits | No | Credit ceiling. Refused with 422 credit_cap_exceeded (nothing charged) when the estimate's maximum exceeds it. | |
| webhook_url | No | URL to POST the records to when the run completes | |
| estimate_cost | No | Validate and price the request without running or charging anything; the 200 response is the credit estimate (EstimateCostResult). |