API referenceEndpoints

Open or restore a draft

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

POST/v1/widgets/{id}/draft

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

Path Parameters

id*string
Formatuuid

Header Parameters

Idempotency-Key?string

Required, at most 200 bytes, only when the body sets from_revision_id to restore that historical design into a new draft. Omit it to resume (or newly open) the one active draft. A replay with the same key restoring the same revision returns the original restored draft unchanged; the same key naming a different revision 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/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft" \  -H "Content-Type: application/json" \  -d '{}'
{}

Get draft

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

Update draft

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