v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
runs

Bulk Create Runs

Create multiple runs with the same configuration.

This endpoint creates multiple runs efficiently:

  • All runs are created in a single database transaction
  • Temporal workflows are started asynchronously
  • Returns immediately with created run details

Maximum 1000 runs can be created in a single request.

post/v1/runs/bulk

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Request body

workflow_idstring uuid required
is_priorityboolean

Prioritize every created run over non-priority runs when assigning eligible machines.

machine_idstring uuid nullable

Machine ID. If not provided, an available machine will be automatically selected.

pool_idsstring[] nullable

Pool IDs to filter available machines. Machine must belong to all of these pools (intersection). Ignored when machine_id is provided.

input_valuesobject nullable

Input values for workflow variables

countinteger required

Number of runs to create (max 1000)

sensitive_input_valuesobject nullable

Sensitive input values (supports nested objects) to store in the secure vault per run. Not persisted in our database. In workflow input_schema, sensitive root keys are validated under a '$' prefixed key.

session_idstring uuid nullable

Join an existing session; overrides machine_id/pool_ids for all runs

start_sessionboolean nullable

Start a new session for these runs; a new UUID will be generated and set on all runs. The first run will attempt to reserve a machine.

Response

Successful Response

failed_countinteger
errorsstring[]