curl --request PATCH \
--url https://api.getoneprofile.ai/ai-context/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"social_proof": "<string>",
"voice": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/ai-context/"
payload = {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"social_proof": "<string>",
"voice": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_description: '<string>',
ideal_buyer_personas: '<string>',
ideal_customer_profile: '<string>',
interest_signals: '<string>',
social_proof: '<string>',
voice: '<string>'
})
};
fetch('https://api.getoneprofile.ai/ai-context/', 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/ai-context/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'company_description' => '<string>',
'ideal_buyer_personas' => '<string>',
'ideal_customer_profile' => '<string>',
'interest_signals' => '<string>',
'social_proof' => '<string>',
'voice' => '<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/ai-context/"
payload := strings.NewReader("{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getoneprofile.ai/ai-context/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/ai-context/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"company_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"last_generated_at": "2023-11-07T05:31:56Z",
"latest_generation_job": {
"created_at": "2023-11-07T05:31:56Z",
"domain": "<string>",
"error": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"social_proof": "<string>",
"source_domain": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"voice": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Update the AI context
Edit the AI business context fields. Omitted fields are left untouched; a field set to null is cleared.
curl --request PATCH \
--url https://api.getoneprofile.ai/ai-context/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"social_proof": "<string>",
"voice": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/ai-context/"
payload = {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"social_proof": "<string>",
"voice": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_description: '<string>',
ideal_buyer_personas: '<string>',
ideal_customer_profile: '<string>',
interest_signals: '<string>',
social_proof: '<string>',
voice: '<string>'
})
};
fetch('https://api.getoneprofile.ai/ai-context/', 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/ai-context/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'company_description' => '<string>',
'ideal_buyer_personas' => '<string>',
'ideal_customer_profile' => '<string>',
'interest_signals' => '<string>',
'social_proof' => '<string>',
'voice' => '<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/ai-context/"
payload := strings.NewReader("{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.getoneprofile.ai/ai-context/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/ai-context/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_description\": \"<string>\",\n \"ideal_buyer_personas\": \"<string>\",\n \"ideal_customer_profile\": \"<string>\",\n \"interest_signals\": \"<string>\",\n \"social_proof\": \"<string>\",\n \"voice\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"company_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"last_generated_at": "2023-11-07T05:31:56Z",
"latest_generation_job": {
"created_at": "2023-11-07T05:31:56Z",
"domain": "<string>",
"error": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"updated_at": "2023-11-07T05:31:56Z",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"social_proof": "<string>",
"source_domain": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"voice": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Body
Request body for editing the context fields (tri-state PATCH semantics).
New value. Set to null to clear.
10000New value. Set to null to clear.
10000New value. Set to null to clear.
10000New value. Set to null to clear.
10000New value. Set to null to clear.
10000The company voice: spelling, formality, what the company calls its product and its buyers, jargon it avoids, how technical it gets. Not length or punctuation. Set to null to clear.
600Response
Successful Response
The org's business context, plus its latest generation job for resume.
The org's most recent generation job, if any. Lets a reloaded page resume polling a job that is still running.
Show child attributes
Show child attributes
The domain last used to generate these fields; null until a generation succeeds.
How the company words things: spelling, formality, what it calls its product and its buyers, jargon it avoids. The outbound agent matches it in every message.
Was this page helpful?