API referenceEndpoints

Create run

Requires an authenticated tenant principal. Generated from the production route registered in `internal/features/workflows/inbound/http.go`.

POST/v1/workflows/{id}/runs

Requires an authenticated tenant principal. Generated from the production route registered in internal/features/workflows/inbound/http.go.

Authorization

bearerAuth
AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key*string

Required, at most 200 bytes; missing is 428. A replay with the same key returns the run the key first started (200 instead of 201), whatever was published since; the same key with a different workflow, version_id or input is 422 {"error":{"type":"invalid_request_error","code":"idempotency_key_reused","message":"this Idempotency-Key was used for a different request"}}.

Lengthlength <= 200

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08/runs" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}