Skip to main content
POST
Simulate policy

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json
profile_id
string<uuid>
required
audience
enum<string> | null
Available options:
customer_agent,
internal_agent,
human,
reviewer,
analyst,
trigger_target,
export
purposes
string[]
Required string length: 1 - 256
source_id
string<uuid> | null

Simulate as this source; or give audience and purposes.

verification
enum<string>
default:V1

Session verification levels. no_customer sits outside the V0-V4 scale.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer
view
string
default:chat
Pattern: ^(voice|chat|brief|full|custom|account|partner|task:[a-z0-9_]{1,40})$

Response

The simulated items, the withheld counts per reason and the resulting text.

audience
enum<string>
required
Available options:
customer_agent,
internal_agent,
human,
reviewer,
analyst,
trigger_target,
export
items
SimulatedItem · object[]
required
policy_version
string
required
text
string
required

The pack the reader would receive.

verification
enum<string>
required

Session verification levels. no_customer sits outside the V0-V4 scale.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer
withheld
Withheld · object
required