Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

nia_sk_...

Body

application/json
query
string
required

Natural language or keywords.

Required string length: 1 - 2000
subject
Handle · object
required

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

about
Handle · object | null

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
filters
HistoryFilters · object
limit
integer | null

At most this many items, after the token budget.

Required range: 1 <= x <= 100
max_tokens
integer
default:800

Budget of the answer. Items are cut by value, never by arrival order. Use 300 for voice.

Required range: 50 <= x <= 4000
task_id
string | null
Required string length: 1 - 512
verification
enum<string>
default:V0

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

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer

Response

Matching items, cut to max_tokens by value.

items
HistoryItem · object[]
required
tokens_used
integer
required
about_unlinked
boolean
default:false

about named an account or partner with no active link to the subject: the rows are the subject's own. It never says whether the organization exists.

as_of
string<date-time> | null
degraded
string | null

text_only when the encoder was unavailable.

ignored
string[]

Filters the server could not read and left out, e.g. when.

recurrence
Recurrence · object | null

How many times this happened, counted over typed episodes. A count, not a guess.

window
TimeWindow · object | null

The period when was read as, when it was read.

withheld
integer
default:0