API referenceEndpoints

Create widget

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

POST/v1/widgets

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

Authorization

bearerAuth
AuthorizationBearer <token>

Engine-issued API key or tenant-signed JWT.

In: header

Header Parameters

Idempotency-Key*string

Required, at most 200 bytes. A replay with the same key and the same source_id/name/model returns the original widget and draft unchanged; the same key with a different value for any of the three is 409 {"error":{"type":"conflict","code":"idempotency_key_reuse","message":"widget changed or preview is no longer current"}}.

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/widgets" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}

List widgets

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

Get widget

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