Admit a batch manifest and queue its items

Admit a batch manifest and queue its items

POST
/api/v1/browser/projects/{projectId}/environments/{environmentId}/workflows/{workflowId}/batches

Admit a batch manifest and queue its items

Authorization

BrowserWorkflowApiKey
headerX-API-Key<token>

Project- and environment-scoped browser workflow API key.

Path Parameters

projectId*string
Formatuuid
environmentId*string
Formatuuid
workflowId*string
Formatuuid

Header Parameters

Idempotency-Key?string

Optional. Generate a unique value before a write and retain it for an exact-body retry; replay is free and a different body returns 409 IDEMPOTENCY_CONFLICT.

Length8 <= length <= 200

Request Body

application/json
  1. body
workflow_version_id*string
Formatuuid
proxy_type?ProxyNetworkType

Requested proxy class inherited by every batch item. Premium is used only when explicitly selected.

Value in"datacenter""residential""premium"
max_credits_per_request?integer

Optional hard credit ceiling applied independently to each run created from this batch.

Range1 <= value
items*array<>
Items1 <= items <= 100000
priority?integer
Range0 <= value <= 9
Default0
configured_concurrency?integer
Range1 <= value <= 32
Default4

Response Body

Admitted workflow batch Error body uses the documented PublicError DTO.

application/json
  1. response
id*string
Formatuuid
parent_batch_id*|
Formatuuid
project_id*string
Formatuuid
environment_id*string
Formatuuid
workflow_id*string
Formatuuid
workflow_version_id*string
Formatuuid
requested_by?integer|null
status*string
configured_concurrency*integer
priority*integer
estimate_units*integer
actual_cost_units*integer
accepted_count*integer
rejected_count*integer
completed_count*integer
failed_count*integer
created_at*string
Formatdate-time
started_at*|
Formatdate-time
finished_at*|
Formatdate-time
curl -X POST 'https://api.runharvester.com/api/v1/browser/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/batches' \  -H 'Content-Type: application/json' \  -d '{  "workflow_version_id": "9c9b9538-e27b-4d40-a8ae-a50aa2ea701b",  "proxy_type": "premium",  "max_credits_per_request": 100,  "items": [    {      "variables": {        "url": "https://example.com"      }    }  ]}' \  --header "X-API-Key: ${RUNHARVESTER_BROWSER_API_KEY:?Set your Browser Workflow API key}" \  --header "Idempotency-Key: ${RUNHARVESTER_IDEMPOTENCY_KEY:?Set a unique key for this submission; reuse it for retries}"
{  "id": "9a20bd58-ed33-4a5b-b63f-b52bb1a62248",  "status": "pending"}