Pular para o conteúdo principal
POST
Python

Autorizações

Authorization
string
header
obrigatório

nia_sk_...

Corpo

application/json
query
string
obrigatório

Linguagem natural ou palavras-chave.

Required string length: 1 - 2000
subject
Handle · object
obrigatório

Um identificador de um sujeito num canal ou sistema: um telefone, um e-mail, um id do CRM.

about
Handle · object | null

Um identificador de um sujeito num canal ou sistema: um telefone, um e-mail, um id do CRM.

conversation_id
string | null
Required string length: 1 - 512
filters
HistoryFilters · object
limit
integer | null

No máximo tantos itens, depois do orçamento de tokens.

Intervalo obrigatório: 1 <= x <= 100
max_tokens
integer
padrão:800

Orçamento da resposta. Os itens são cortados por valor, nunca pela ordem de chegada. Use 300 na voz.

Intervalo obrigatório: 50 <= x <= 4000
task_id
string | null
Required string length: 1 - 512
verification
enum<string>
padrão:V0

Nível de verificação da sessão. V0 autodeclarado, V1 plausível pelo canal, V2 atestado pelo canal, V3 desafiado (OTP ou login), V4 conferido com um sistema de registro ou por um atendente. no_customer vale para tarefas sem cliente presente e só é aceito de fontes de agente interno.

Opções disponíveis:
V0,
V1,
V2,
V3,
V4,
no_customer

Resposta

Os itens encontrados, cortados por valor até max_tokens.

items
HistoryItem · object[]
obrigatório
tokens_used
integer
obrigatório
about_unlinked
boolean
padrão:false

about citou uma conta ou parceiro sem vínculo ativo com o sujeito: as linhas são as do próprio sujeito. Nunca diz se a organização existe.

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

text_only quando a busca por significado não estava disponível e só a busca por palavra rodou.

ignored
string[]

Filtros que o servidor não conseguiu ler e deixou de fora, como when.

recurrence
Recurrence · object | null

Quantas vezes isso aconteceu, contado sobre episódios tipados. Uma contagem, não um palpite.

window
TimeWindow · object | null

O período em que when foi lido, quando foi lido.

withheld
integer
padrão:0