Skip to main content
POST
Suggest a dataset and field mappings for a sample payload

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Body

application/json
sample
any
required

A sample payload — any JSON value except null. Objects are stringified; the text is truncated to 6000 characters before the model sees it.

hint
string

Free-text context. Also used as the fallback dataset name when the model's suggestion is not a valid identifier.

Response

Advisory only — nothing is created. The model's output is normalized and hard-bounded here (keys coerced to unique snake_case, at most 50 mappings and 20 conditions, paths truncated to 200 chars) and still re-validated when the caller actually creates the rule or webhook.

dataset
string
required

Falls back to the hint, then to 'events'.

mappings
object[]
required
Maximum array length: 50
conditions
object[]
required

Equality-only, matching the routing-rule condition shape. Paths beginning with '$' are dropped.

Maximum array length: 20