Skip to main content
Build the workflow once in the Workflow Editor or as JSON, then feed it rows. To research a list with People or Company Intelligence and nothing else, Bulk Intelligence needs no workflow.

Run a batch in the editor

  1. Open the workflow and click Run. The run dialog shows the estimated cost.
  2. Click Runs in the editor header to follow progress block by block.
  3. Download the results from the run, or deliver them with a Send Results block such as Append to Notebook or Outgoing Webhooks.

Send rows in the request

Runs started through the API follow three steps: POST /v1/workflows/{workflow_id}/runs starts the run and returns a Job. What you send depends on the workflow’s first block:
  • Incoming Webhooks: pass the rows in input, a list of objects, one per row.
  • Upload Data (read_csv): upload the file and pass its file_id as source_overrides.resource_handle_id.
  • Any other first block: send an empty body, {}.
The run is asynchronous. Poll GET /v1/jobs/{job_id} until status is succeeded, failed or canceled, waiting next_poll_after seconds between polls. A finished Job lists one output file per block in result. The file with the highest block_number is the final output. Fetch its download_url with your x-api-key header.
For the Job’s fields and a full response, see Check a run.
CSV downloads are spreadsheet-safe by default: formula-like cells, such as ones that start with =, +, or @, get a leading ', so +14155550123 becomes '+14155550123. Add spreadsheet_safe=false to the download_url query string for the file exactly as stored, or send "result_formats": ["csv", "ndjson"] when code reads the results. See Spreadsheet-safe CSV.
Retrying the request with the same Idempotency-Key header and body returns the existing Job instead of starting a new run. Workflow Execution covers cancellation, failed rows, output formats and every response field. For credit costs, see Credit Costs. For error responses, see Handling Errors. The original /workflows/run routes keep working and are documented under Legacy.

Tips

  • Filter before research. Fewer rows means faster runs and fewer credits.
  • Use Deduplicate with Notebook on recurring batches so each run saves only new rows.
  • Define only the return fields you need in Intelligence blocks.
  • Add an Outgoing Webhooks block to receive results when the run completes instead of polling.