Reference
API reference
The HTTP API. Every endpoint is versioned and returns problem details on error.
Start a run#
curl -X POST https://api.vectorbea.com/v1/runs \ -H "Authorization: Bearer $VECTORBEA_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "workflowId": "wf_7c2f18ab", "environment": "production", "input": { "lookaheadDays": 30 } }'| Field | Type | Description |
|---|---|---|
workflowIdrequired | string | The workflow to run. Uses the currently published version unless versionId is given. |
environmentrequired | "production" | "staging" | "development" | Which environment's connections and budgets apply. |
input | object | Must satisfy the trigger's declared input schema. Unknown fields are rejected rather than ignored. |
idempotencyKey | string | Starting twice with the same key returns the original run instead of creating a second one. |
202Accepted. The run is queued; it has not started.
| Field | Type | Description |
|---|---|---|
id | string | Run id, prefixed run_. |
status | "queued" | Always queued on creation — a 202 never means running. |
workflowId | string | Echoed back. |
createdAt | string (ISO-8601) | When the run was accepted. |
409A run with this idempotency key already exists.
| Field | Type | Description |
|---|---|---|
type | string | https://vectorbea.com/problems/duplicate-run |
existingRunId | string | The run created by the first request. Treat this as success. |
Was this page helpful?