Skip to main content
POST
Record a search applied without the AI Assistant

Authorizations

X-API-Key
string
header
required

Path Parameters

conversation_id
string<uuid>
required

Body

application/json

Record filters the client applied itself, as a turn with no model call.

For Try ideas, starter cards and the Switch to chip. asked is the user message to record (the idea's label, say), or null to record the reply alone. said is the reply naming what was set. A Switch to also sends the reading it left as alternative and the name of the one it chose as chosen_label, so the reply offers the way back; both filter sets are checked the same way.

query
Query · object
required
record_type
enum<string>
required

Which dataset a search runs against, and so which provider serves it.

Values are persisted in String(16) columns, so every member must stay within 16 characters.

Available options:
people,
companies,
signal_companies,
signal_people,
lookalikes,
local_businesses,
tech_companies,
hiring_companies
said
string
required
Required string length: 1 - 1000
alternative
LeadChatAppliedAlternativeSchema · object | null

The other reading an applied search keeps one tap away, named and complete.

asked
string | null
Required string length: 1 - 4000
chosen_label
string
default:""
Maximum string length: 200

Response

Successful Response

An applied turn, as saved; user_message is null when nothing was asked.

assistant_message
LeadChatMessageReadSchema · object
required

One message in a conversation.

Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and neither is the customer's.

user_message
LeadChatMessageReadSchema · object | null
required

One message in a conversation.

Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and neither is the customer's.