Read the preview
curl --request GET \
--url https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/', 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/onboarding-wizard/runs/{run_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"build_error": "<string>",
"claimed": true,
"context": {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"pilot_offer": "<string>",
"social_proof": "<string>"
},
"dns_issue": "no_dmarc",
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insights_error": "<string>",
"join_requested_at": "2023-11-07T05:31:56Z",
"launch_error": "<string>",
"launched_at": "2023-11-07T05:31:56Z",
"messages": [
{
"email_body": "<string>",
"email_subject": "<string>",
"label": "<string>",
"linkedin_body": "<string>",
"looks_good": true,
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "writing"
}
],
"outlook_available": true,
"people": [
{
"company": "<string>",
"email": "<string>",
"email_status": "valid",
"in_preview": true,
"linkedin_url": "<string>",
"name": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"researched": true,
"title": "<string>",
"why": "<string>"
}
],
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"description": "<string>",
"index": 123,
"label": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "researching",
"stalled": true
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}onboarding-wizard
Read the preview
Everything the wizard shows: the stage, the research as it runs, the segments, the 100 people with what the research found for the top 10, and their first messages.
GET
/
onboarding-wizard
/
runs
/
{run_id}
/
Read the preview
curl --request GET \
--url https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/ \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/', 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/onboarding-wizard/runs/{run_id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/runs/{run_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"build_error": "<string>",
"claimed": true,
"context": {
"company_description": "<string>",
"ideal_buyer_personas": "<string>",
"ideal_customer_profile": "<string>",
"interest_signals": "<string>",
"pilot_offer": "<string>",
"social_proof": "<string>"
},
"dns_issue": "no_dmarc",
"domain": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"insights_error": "<string>",
"join_requested_at": "2023-11-07T05:31:56Z",
"launch_error": "<string>",
"launched_at": "2023-11-07T05:31:56Z",
"messages": [
{
"email_body": "<string>",
"email_subject": "<string>",
"label": "<string>",
"linkedin_body": "<string>",
"looks_good": true,
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "writing"
}
],
"outlook_available": true,
"people": [
{
"company": "<string>",
"email": "<string>",
"email_status": "valid",
"in_preview": true,
"linkedin_url": "<string>",
"name": "<string>",
"record_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"researched": true,
"title": "<string>",
"why": "<string>"
}
],
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"description": "<string>",
"index": 123,
"label": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "researching",
"stalled": true
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Response
Successful Response
A preview: everything the wizard's page shows.
Where a run stands, derived from what it holds. Never stored.
The frontend's five steps map onto these: researching and segments are step 1 and 2, finding is step 3, and writing is step 4 from the first message written (the page reads the messages themselves to tell).
Available options:
researching, research_failed, segments, finding, finding_failed, writing, launched Was this page helpful?