API referenceEndpoints

Create run

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

POST/v1/schedules/{id}/run

Requires an authenticated tenant principal. Generated from the production route registered in internal/features/schedules/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. This route takes no body, so a replay with the same key always returns the originally triggered run unchanged; a key already used for a different schedule's run is 409 {"error":{"type":"conflict","message":"Idempotency-Key reused with a different request"}} — no code.

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/schedules/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}