Skip to main content
POST
Preview a scenario drafted from real traffic

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Headers

x-tenant-id
string

Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.

Minimum string length: 1
x-organization-id
string

Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.

Minimum string length: 1

Body

application/json
source
object
required

One delivery an automation trigger admitted.

Response

OK

automationId
string<uuid>
required

The automation the scenario simulates.

lossy
object[]
required

Each detail of the source the scenario dropped or regenerated.

scenario
object
required

One scenario of a schemaVersion 1 batch, already validated, with effective limits. It carries the source's customer content.