curl --request POST \
--url https://api.getoneprofile.ai/onboarding-wizard/own-runs/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"domain": "<string>",
"replace_context": false,
"timezone": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/own-runs/"
payload = {
"domain": "<string>",
"replace_context": False,
"timezone": "<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({domain: '<string>', replace_context: false, timezone: '<string>'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/own-runs/', 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/own-runs/",
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([
'domain' => '<string>',
'replace_context' => false,
'timezone' => '<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/onboarding-wizard/own-runs/"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<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/onboarding-wizard/own-runs/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/own-runs/")
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 \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<string>\"\n}"
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",
"learnings": [
"<string>"
],
"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,
"own_workspace": 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>"
}
],
"people_table_ready": true,
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"batch": 123,
"companies": "<string>",
"counted": true,
"description": "<string>",
"index": 123,
"job_titles": [
"<string>"
],
"label": "<string>",
"matches": 123,
"reason": "<string>",
"too_small": true,
"wanted": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_token": "<string>",
"stage": "researching",
"stalled": true,
"company_name": "<string>",
"connect_credits": 0,
"credits_left": 0,
"credits_per_person": 0,
"headline": "<string>",
"logo_path": "<string>",
"people_covered": 0,
"preview_settled": false,
"subheadline": "<string>",
"suggestions_full": false,
"switch_credits": 0
}{
"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>"
}Start the wizard in your own workspace
The wizard after sign-up: researches the company into the signed-in person’s active workspace and offers its segments, as a preview does, with nothing to claim at the end. Answers the session token the other wizard routes take as X-Wizard-Session, together with the person’s sign-in. Refused for a personal mail domain, a website nothing answers at (422, no_website), a company’s page on another site such as linkedin.com/company/acme (422, platform_page), past three companies a person a day, and past the day’s cap. Only the person who created the workspace may start it: a teammate who joined is refused. When the workspace’s Business context describes another website, refused (422, other_company) unless replace_context is set, which rewrites it from this one and only a workspace admin may set (403). While a research of another website still writes the workspace’s Business context, it answers 409 with a Retry-After: the same start goes once that research is done.
curl --request POST \
--url https://api.getoneprofile.ai/onboarding-wizard/own-runs/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"domain": "<string>",
"replace_context": false,
"timezone": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/onboarding-wizard/own-runs/"
payload = {
"domain": "<string>",
"replace_context": False,
"timezone": "<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({domain: '<string>', replace_context: false, timezone: '<string>'})
};
fetch('https://api.getoneprofile.ai/onboarding-wizard/own-runs/', 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/own-runs/",
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([
'domain' => '<string>',
'replace_context' => false,
'timezone' => '<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/onboarding-wizard/own-runs/"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<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/onboarding-wizard/own-runs/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/onboarding-wizard/own-runs/")
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 \"domain\": \"<string>\",\n \"replace_context\": false,\n \"timezone\": \"<string>\"\n}"
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",
"learnings": [
"<string>"
],
"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,
"own_workspace": 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>"
}
],
"people_table_ready": true,
"research": {
"error": "<string>",
"status": "pending",
"steps": [
{
"action": "<string>",
"detail": "",
"duration_ms": 123,
"observation": "",
"outcome": "completed",
"thought": "<string>"
}
]
},
"segment_index": 123,
"segments": [
{
"batch": 123,
"companies": "<string>",
"counted": true,
"description": "<string>",
"index": 123,
"job_titles": [
"<string>"
],
"label": "<string>",
"matches": 123,
"reason": "<string>",
"too_small": true,
"wanted": "<string>"
}
],
"sender_name": "<string>",
"sender_source": "about_page",
"sender_title": "<string>",
"sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_token": "<string>",
"stage": "researching",
"stalled": true,
"company_name": "<string>",
"connect_credits": 0,
"credits_left": 0,
"credits_per_person": 0,
"headline": "<string>",
"logo_path": "<string>",
"people_covered": 0,
"preview_settled": false,
"subheadline": "<string>",
"suggestions_full": false,
"switch_credits": 0
}{
"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>"
}Body
Start a preview for one company.
Response
Successful Response
A preview the moment it starts, or an own run its signed-in owner found again.
The only responses that carry its session token. Its own schema rather than a field
on WizardRunReadSchema, so no read with the token alone can serve it back.
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).
researching, research_failed, segments, finding, finding_failed, writing, launched Was this page helpful?