API referenceEndpoints

Create message

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

POST/v1/widgets/{id}/draft/messages

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. A replay with the same key and the same expected_revision/text/decision returns the original authoring job 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/497f6eca-6276-4993-bfeb-53cbbbba6f08/draft/messages" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{}

List draft messages

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

Publish a draft

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