API reference
Find Data API and Browser Workflow operations by task.
API reference.
Submit URLs with the Data API or run published browser workflows. Choose an operation below for its parameters, response schemas, examples, and playground.
Choose an API
| API | Use it to | Authentication |
|---|---|---|
| Data API | Fetch pages, extract fields, and submit batches of URLs. | Data API key with scrape:write and/or requests:read. |
| Browser Workflow API | Run a published workflow, inspect evidence, and manage batch runs or webhooks. | Browser Workflow key scoped to a project and environment. |
All paths use https://api.runharvester.com. See Authentication to create the right key. Workspace setup and account-management routes belong to the Console and are outside this reference.
The playground sends requests directly from your browser to the API. Submitting a request can create billable work. For copyable cURL examples, set RUNHARVESTER_API_KEY or RUNHARVESTER_BROWSER_API_KEY. For a write operation, also set RUNHARVESTER_IDEMPOTENCY_KEY to a fresh UUID before its first submission and keep it unchanged for retries of the same body. See Retries and idempotency.
Data API
New to asynchronous requests? Start with the quickstart.
| Task | Operation |
|---|---|
| Submit a URL | Create a request |
| Check progress | Get a request |
| Read the result | Get a result |
| Inspect execution events | List request events |
| Browse previous requests | List requests |
| Stop work | Cancel a request |
| Intentionally submit a new attempt | Retry a request |
| Submit many URLs | Create a batch |
| Check a batch | Get a batch |
| Browse batches | List batches |
| Inspect measured traffic and post-paid charges | Get usage |
| Browse extraction recipes | List recipes |
| Receive request events as a live stream | Stream request events |
Browser Workflow API
These operations use a project ID and environment ID. Start with Browser workflows for setup and credential boundaries.
Runs and evidence
| Task | Operation |
|---|---|
| Inspect the key's environment | Get environment |
| Execute a published version | Create a run |
| Check execution status | Get a run |
| Stop execution | Cancel a run |
| Find evidence | List run evidence |
| Retrieve evidence | Get an evidence item |
| Connect your browser automation | Create a CDP session |
| Finish a CDP session | Complete a CDP session |
Batches
| Task | Operation |
|---|---|
| Submit workflow variables in JSON | Create a batch |
| Stream a large NDJSON manifest | Submit a manifest |
| Check a batch | Get a batch |
| Browse batches | List batches |
| Retry failed items | Retry a batch's failures |
Webhooks
| Task | Operation |
|---|---|
| Register a destination | Create a webhook |
| Browse destinations | List webhooks |
| Inspect delivery attempts | List deliveries |
| Redeliver an event | Replay a delivery |
See the integration guide for streaming manifests and signature verification. For failures and production behavior, use Errors, Limits, and Security and privacy.
Last updated on