Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json
subject
Handle · object
required

An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.

conversation_id
string | null
Required string length: 1 - 512
for
string
default:self
Pattern: ^(?:self|gift|beneficiary:[A-Za-z0-9_-]{1,64})$
tool
string | null

Rendered for this tool's bindings.

Required string length: 1 - 256

Response

Successful Response

What one subject wants, refuses and is, for the tools of this turn (constraints.v0).

text
string
required

The block as lines for a model, in the space's language, each field by its label and each operator in words; an empty string when the block has nothing to say. Not part of version.

version
string
required

A digest of the block, which the turn record cites.

Pattern: ^cv_[0-9a-f]{8,64}$
already_presented
Shown · object[]
Maximum array length: 200
ask
string[]

Questions the agent should ask, as for_whom, before assuming.

Required string length: 1 - 256
attributes
AttributeEntry · object[]
Maximum array length: 50
conflicts
Conflict · object[]
Maximum array length: 50
exclude
string[]
Maximum array length: 200
Pattern: ^[a-z][a-z0-9_]{0,39}:[^:\s]{1,256}:\S{1,512}$
hard
HardConstraint · object[]
Maximum array length: 100
precedence
enum<string>[]
Available options:
current_utterance,
stated_persistent,
inferred
relaxation_order
string[]

What gives way first when a search finds nothing: soft, ids.

rendered
Rendered · object | null

The block for one tool, through its bindings (constraints.v0, rendering).

rules
CompanyRule · object[]
Maximum array length: 50
soft
SoftConstraint · object[]
Maximum array length: 100
subject
BlockSubject · object