curl --request POST \
--url https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"query": {},
"surface": "panel"
}
'import requests
url = "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/"
payload = {
"prompt": "<string>",
"query": {},
"surface": "panel"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompt: '<string>', query: {}, surface: 'panel'})
};
fetch('https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'query' => [
],
'surface' => 'panel'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}"
response = http.request(request)
puts response.read_body{
"assistant_message": {
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"alternative": {
"label": "<string>",
"query": {}
},
"at_capacity": false,
"chosen_label": "",
"match_count": 123,
"nothing_found": false,
"other_search": "signals",
"query": {},
"question_options": [
"<string>"
],
"record_type": "people"
},
"role": "user",
"sequence": 123,
"state": "asking",
"status": "complete",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"user_message": {
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"alternative": {
"label": "<string>",
"query": {}
},
"at_capacity": false,
"chosen_label": "",
"match_count": 123,
"nothing_found": false,
"other_search": "signals",
"query": {},
"question_options": [
"<string>"
],
"record_type": "people"
},
"role": "user",
"sequence": 123,
"state": "asking",
"status": "complete",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": {
"detail": "<string>",
"reason": "limit"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Ask the AI Assistant
Run one turn and answer when it is done: the fallback for a client that cannot open the streaming route. The reply’s state says what it became: ready (a search, with its free match count), asking (one question, with answers to tap) or other_search (the search that covers the ask, which opens empty).
A turn that breaks still answers 201, with the reply’s status set to failed: an error status would roll back the row that records it. A refused turn (today’s limit, or the AI Assistant paused) answers 429 and writes nothing.
curl --request POST \
--url https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"query": {},
"surface": "panel"
}
'import requests
url = "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/"
payload = {
"prompt": "<string>",
"query": {},
"surface": "panel"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({prompt: '<string>', query: {}, surface: 'panel'})
};
fetch('https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'query' => [
],
'surface' => 'panel'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/find-leads/assistant/conversations/{conversation_id}/messages/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"query\": {},\n \"surface\": \"panel\"\n}"
response = http.request(request)
puts response.read_body{
"assistant_message": {
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"alternative": {
"label": "<string>",
"query": {}
},
"at_capacity": false,
"chosen_label": "",
"match_count": 123,
"nothing_found": false,
"other_search": "signals",
"query": {},
"question_options": [
"<string>"
],
"record_type": "people"
},
"role": "user",
"sequence": 123,
"state": "asking",
"status": "complete",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"user_message": {
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"alternative": {
"label": "<string>",
"query": {}
},
"at_capacity": false,
"chosen_label": "",
"match_count": 123,
"nothing_found": false,
"other_search": "signals",
"query": {},
"question_options": [
"<string>"
],
"record_type": "people"
},
"role": "user",
"sequence": 123,
"state": "asking",
"status": "complete",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": {
"detail": "<string>",
"reason": "limit"
}
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Path Parameters
Body
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.
1 - 4000Which 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.
people, companies, signal_companies, signal_people, lookalikes, local_businesses, tech_companies, hiring_companies Where a turn was sent from, for the turn log only.
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.
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.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
Was this page helpful?