Runs

Create run

Start an asynchronous workflow run. Returns 202 with URLs to poll status, read events, and stream progress.

post/runs

Request

  • Base URL: https://api.edgaze.ai/v1
  • URL: https://api.edgaze.ai/v1/runs
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Currently optional for backward compatibility, but strongly recommended for every request (max 255 chars). Prefer the header over body.idempotencyKey; when both are set they must match, or the request is rejected with 400 invalid_request. Values are case-sensitive and scoped to the Edgaze account. The fingerprint covers workflow, normalized inputs, and requested version. An exact replay returns the original run; a different request returns 409 idempotency_conflict. Keys have no time-based expiry while the run record exists.

Request body

workflowstring uuid

Workflow UUID to run.

workflowIdstring uuid

Deprecated compatibility alias for workflow. Prefer workflow. When both are set, workflow wins.

inputsobject

Map of exact input nodeId (preferred) or name to value, using the keys from the workflow's inputSchema. Unknown or ambiguous keys are rejected with 400 invalid_inputs. Omit entirely for a workflow that takes no inputs.

idempotencyKeystring

Currently optional for backward compatibility, but strongly recommended for every request. Account-scoped and case-sensitive (max 255 chars). Prefer the Idempotency-Key header; when both are set they must match. The fingerprint covers workflow, normalized inputs, and requested version.

versionstring uuid

Optional immutable workflow version to run. When omitted, resolves to the caller's pinned version, or the workflow's active version when there is no pin.

Example request

{
  "workflow": "550e8400-e29b-41d4-a716-446655440000",
  "workflowId": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Run accepted.

Changes

No recorded changes to this operation across all 1 revision of this API.