Skip to main content
POST
Ask the AI Assistant

Authorizations

X-API-Key
string
header
required

Path Parameters

conversation_id
string<uuid>
required

Body

application/json

Send the AI Assistant a message.

record_type and query are the search on screen, when there is one: the results panel sends them so a refinement builds on what the user sees. The page sends neither. The query is checked against the same schema a hand-built search goes through, and unknown filters are stripped.

prompt
string
required
Required string length: 1 - 4000
query
Query · object | null
record_type
enum<string> | null

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
surface
enum<string>
default:panel

Where a turn was sent from, for the turn log only.

Available options:
page,
panel

Response

Successful Response

Both halves of one turn, as saved.

The user message too, not just the reply: the client drew its own copy before sending and reconciles it against this one.

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
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.