Ask the AI Assistant
curl --request POST \
--url https://api.getoneprofile.ai/assistant/conversations/{conversation_id}/messages/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted": [
"<string>"
],
"quote": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/assistant/conversations/{conversation_id}/messages/"
payload = {
"prompt": "<string>",
"attachment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted": ["<string>"],
"quote": "<string>"
}
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>',
attachment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
page: {
entity_id: '<string>',
entity_name: '<string>',
entity_type: '<string>',
page_name: '<string>',
route: '<string>',
selected_step_id: '<string>',
selected_step_label: '<string>'
},
pasted: ['<string>'],
quote: '<string>'
})
};
fetch('https://api.getoneprofile.ai/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/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>',
'attachment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'page' => [
'entity_id' => '<string>',
'entity_name' => '<string>',
'entity_type' => '<string>',
'page_name' => '<string>',
'route' => '<string>',
'selected_step_id' => '<string>',
'selected_step_label' => '<string>'
],
'pasted' => [
'<string>'
],
'quote' => '<string>'
]),
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/assistant/conversations/{conversation_id}/messages/"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\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/assistant/conversations/{conversation_id}/messages/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/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 \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assistant_message": {
"actions": [
{
"applied_result": {},
"approve_label": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display_name": "<string>",
"error": "<string>",
"grantable": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "verb",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "chat",
"price_aside": "<string>",
"price_credits": 123,
"price_label": "<string>",
"proposed_at": "2023-11-07T05:31:56Z",
"source_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "proposed",
"summary": "<string>",
"verb": "<string>",
"verb_label": "<string>",
"charged_credits": 123,
"destructive": false,
"detail": {
"kind": "text",
"after": "",
"before": "",
"landing": {
"adds": "<string>",
"table_name": "<string>",
"sample_columns": [
"<string>"
],
"sample_rows": [
[
"<string>"
]
]
},
"search": {
"record_type": "people",
"query": {}
},
"search_before": {
"record_type": "people",
"query": {}
},
"text": ""
},
"expected_credits": 123,
"loss": "<string>",
"prepared_column": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dependent_column_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"price_per": "call",
"runs_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attachments": [
{
"column_count": 123,
"columns": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "spreadsheet",
"page_count": 123,
"row_count": 123,
"sent": true,
"sheet": "<string>",
"size_bytes": 123
}
],
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted_count": 123,
"pasted_kind": "domains",
"plan": [
"<string>"
],
"plan_done": 123,
"question": {
"text": "<string>",
"options": [
"<string>"
]
},
"quote": "<string>",
"role": "user",
"segments": [
{
"action_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"text": "<string>"
}
],
"sequence": 123,
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
],
"suggestion_kinds": [
"business_context"
],
"suggestions": [
"<string>"
]
},
"user_message": {
"actions": [
{
"applied_result": {},
"approve_label": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display_name": "<string>",
"error": "<string>",
"grantable": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "verb",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "chat",
"price_aside": "<string>",
"price_credits": 123,
"price_label": "<string>",
"proposed_at": "2023-11-07T05:31:56Z",
"source_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "proposed",
"summary": "<string>",
"verb": "<string>",
"verb_label": "<string>",
"charged_credits": 123,
"destructive": false,
"detail": {
"kind": "text",
"after": "",
"before": "",
"landing": {
"adds": "<string>",
"table_name": "<string>",
"sample_columns": [
"<string>"
],
"sample_rows": [
[
"<string>"
]
]
},
"search": {
"record_type": "people",
"query": {}
},
"search_before": {
"record_type": "people",
"query": {}
},
"text": ""
},
"expected_credits": 123,
"loss": "<string>",
"prepared_column": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dependent_column_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"price_per": "call",
"runs_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attachments": [
{
"column_count": 123,
"columns": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "spreadsheet",
"page_count": 123,
"row_count": 123,
"sent": true,
"sheet": "<string>",
"size_bytes": 123
}
],
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted_count": 123,
"pasted_kind": "domains",
"plan": [
"<string>"
],
"plan_done": 123,
"question": {
"text": "<string>",
"options": [
"<string>"
]
},
"quote": "<string>",
"role": "user",
"segments": [
{
"action_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"text": "<string>"
}
],
"sequence": 123,
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
],
"suggestion_kinds": [
"business_context"
],
"suggestions": [
"<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>"
}assistant
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 AI Assistant answers questions about the workspace and the product, and takes the eight workspace actions when asked: each lands as a card under the reply, applied when the workspace’s rules allow it and proposed for approval otherwise. A request that needs a table’s rows or a search it cannot run is answered with where to ask it.
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 (the workspace’s allowance is spent, or the AI Assistant is paused) answers 429 and writes nothing. A message naming a file that is not yours, or was already sent, answers 422 and writes nothing.
POST
/
assistant
/
conversations
/
{conversation_id}
/
messages
/
Ask the AI Assistant
curl --request POST \
--url https://api.getoneprofile.ai/assistant/conversations/{conversation_id}/messages/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"attachment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted": [
"<string>"
],
"quote": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/assistant/conversations/{conversation_id}/messages/"
payload = {
"prompt": "<string>",
"attachment_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted": ["<string>"],
"quote": "<string>"
}
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>',
attachment_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
page: {
entity_id: '<string>',
entity_name: '<string>',
entity_type: '<string>',
page_name: '<string>',
route: '<string>',
selected_step_id: '<string>',
selected_step_label: '<string>'
},
pasted: ['<string>'],
quote: '<string>'
})
};
fetch('https://api.getoneprofile.ai/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/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>',
'attachment_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'page' => [
'entity_id' => '<string>',
'entity_name' => '<string>',
'entity_type' => '<string>',
'page_name' => '<string>',
'route' => '<string>',
'selected_step_id' => '<string>',
'selected_step_label' => '<string>'
],
'pasted' => [
'<string>'
],
'quote' => '<string>'
]),
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/assistant/conversations/{conversation_id}/messages/"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\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/assistant/conversations/{conversation_id}/messages/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/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 \"attachment_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"page\": {\n \"entity_id\": \"<string>\",\n \"entity_name\": \"<string>\",\n \"entity_type\": \"<string>\",\n \"page_name\": \"<string>\",\n \"route\": \"<string>\",\n \"selected_step_id\": \"<string>\",\n \"selected_step_label\": \"<string>\"\n },\n \"pasted\": [\n \"<string>\"\n ],\n \"quote\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"assistant_message": {
"actions": [
{
"applied_result": {},
"approve_label": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display_name": "<string>",
"error": "<string>",
"grantable": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "verb",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "chat",
"price_aside": "<string>",
"price_credits": 123,
"price_label": "<string>",
"proposed_at": "2023-11-07T05:31:56Z",
"source_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "proposed",
"summary": "<string>",
"verb": "<string>",
"verb_label": "<string>",
"charged_credits": 123,
"destructive": false,
"detail": {
"kind": "text",
"after": "",
"before": "",
"landing": {
"adds": "<string>",
"table_name": "<string>",
"sample_columns": [
"<string>"
],
"sample_rows": [
[
"<string>"
]
]
},
"search": {
"record_type": "people",
"query": {}
},
"search_before": {
"record_type": "people",
"query": {}
},
"text": ""
},
"expected_credits": 123,
"loss": "<string>",
"prepared_column": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dependent_column_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"price_per": "call",
"runs_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attachments": [
{
"column_count": 123,
"columns": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "spreadsheet",
"page_count": 123,
"row_count": 123,
"sent": true,
"sheet": "<string>",
"size_bytes": 123
}
],
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted_count": 123,
"pasted_kind": "domains",
"plan": [
"<string>"
],
"plan_done": 123,
"question": {
"text": "<string>",
"options": [
"<string>"
]
},
"quote": "<string>",
"role": "user",
"segments": [
{
"action_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"text": "<string>"
}
],
"sequence": 123,
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
],
"suggestion_kinds": [
"business_context"
],
"suggestions": [
"<string>"
]
},
"user_message": {
"actions": [
{
"applied_result": {},
"approve_label": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display_name": "<string>",
"error": "<string>",
"grantable": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "verb",
"message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "chat",
"price_aside": "<string>",
"price_credits": 123,
"price_label": "<string>",
"proposed_at": "2023-11-07T05:31:56Z",
"source_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "proposed",
"summary": "<string>",
"verb": "<string>",
"verb_label": "<string>",
"charged_credits": 123,
"destructive": false,
"detail": {
"kind": "text",
"after": "",
"before": "",
"landing": {
"adds": "<string>",
"table_name": "<string>",
"sample_columns": [
"<string>"
],
"sample_rows": [
[
"<string>"
]
]
},
"search": {
"record_type": "people",
"query": {}
},
"search_before": {
"record_type": "people",
"query": {}
},
"text": ""
},
"expected_credits": 123,
"loss": "<string>",
"prepared_column": {
"column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dependent_column_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"price_per": "call",
"runs_column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"attachments": [
{
"column_count": 123,
"columns": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "spreadsheet",
"page_count": 123,
"row_count": 123,
"sent": true,
"sheet": "<string>",
"size_bytes": 123
}
],
"content": "<string>",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"duration_ms": 123,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page": {
"entity_id": "<string>",
"entity_name": "<string>",
"entity_type": "<string>",
"page_name": "<string>",
"route": "<string>",
"selected_step_id": "<string>",
"selected_step_label": "<string>"
},
"pasted_count": 123,
"pasted_kind": "domains",
"plan": [
"<string>"
],
"plan_done": 123,
"question": {
"text": "<string>",
"options": [
"<string>"
]
},
"quote": "<string>",
"role": "user",
"segments": [
{
"action_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"text": "<string>"
}
],
"sequence": 123,
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
],
"suggestion_kinds": [
"business_context"
],
"suggestions": [
"<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
APIKeyHeaderHTTPBearer
Path Parameters
Body
application/json
Send the AI Assistant a message.
Required string length:
1 - 4000The files sent with this message, as the attachments route returned them when they were uploaded: CSV, Excel or PDF, each of them yours and not yet sent with another message. The assistant reads a spreadsheet's columns and rows and a PDF's pages. Optional.
Maximum array length:
10What you have open, so the assistant can resolve 'this table' without you naming it. Optional.
Show child attributes
Show child attributes
A list you pasted rather than typed: domains, emails, names, one per entry. Sent as data instead of prose, so the assistant reads it as a list and the conversation shows it as a count rather than a wall of text. Optional.
Maximum array length:
1000Maximum string length:
200Part of an earlier reply you selected, sent with your words so the assistant knows what they refer to. Kept with the message and shown above it in the conversation. Optional.
Required string length:
1 - 2000Response
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, with the action cards a reply raised.
Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and the tokens, the dollars and the model are the operator's, kept on the row for the costs page and never returned here. The cards ride on the message so a transcript renders them under the right reply without a second request.
duration_ms is the exception to that rule, and deliberately so: how
long an answer took is the customer's own time, and a reply that says it
took forty seconds reads as work rather than as a stall.
Show child attributes
Show child attributes
One message in a conversation, with the action cards a reply raised.
Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and the tokens, the dollars and the model are the operator's, kept on the row for the costs page and never returned here. The cards ride on the message so a transcript renders them under the right reply without a second request.
duration_ms is the exception to that rule, and deliberately so: how
long an answer took is the customer's own time, and a reply that says it
took forty seconds reads as work rather than as a stall.
Show child attributes
Show child attributes
Was this page helpful?