Enrich an analysis
curl --request POST \
--url https://preuve.ai/api/agent/analyses/{id}/enrich \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"modules": [
"founderFit",
"playbook"
],
"founderProfile": {
"hoursPerWeek": 20,
"runwayMonths": 6,
"domainYears": 3,
"shippedBefore": "side_project",
"audienceSize": "under_1k",
"teamStatus": "solo"
}
}
'import requests
url = "https://preuve.ai/api/agent/analyses/{id}/enrich"
payload = {
"modules": ["founderFit", "playbook"],
"founderProfile": {
"hoursPerWeek": 20,
"runwayMonths": 6,
"domainYears": 3,
"shippedBefore": "side_project",
"audienceSize": "under_1k",
"teamStatus": "solo"
}
}
headers = {
"x-preuve-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-preuve-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
modules: ['founderFit', 'playbook'],
founderProfile: {
hoursPerWeek: 20,
runwayMonths: 6,
domainYears: 3,
shippedBefore: 'side_project',
audienceSize: 'under_1k',
teamStatus: 'solo'
}
})
};
fetch('https://preuve.ai/api/agent/analyses/{id}/enrich', 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://preuve.ai/api/agent/analyses/{id}/enrich",
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([
'modules' => [
'founderFit',
'playbook'
],
'founderProfile' => [
'hoursPerWeek' => 20,
'runwayMonths' => 6,
'domainYears' => 3,
'shippedBefore' => 'side_project',
'audienceSize' => 'under_1k',
'teamStatus' => 'solo'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-preuve-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://preuve.ai/api/agent/analyses/{id}/enrich"
payload := strings.NewReader("{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-preuve-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://preuve.ai/api/agent/analyses/{id}/enrich")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses/{id}/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-preuve-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}"
response = http.request(request)
puts response.read_body{
"analysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanType": "starter",
"enrichmentMode": "core",
"publish": true,
"reportType": "quick",
"analysisTier": "basic",
"status": "PENDING",
"progressStep": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"resetAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"pollHint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"readyForExport": true,
"exportable": true,
"exportBlockedCode": "REPORT_NOT_FROM_AGENT_RUN",
"exportBlockedHint": "<string>",
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"modules": {
"proofOfDemand": {
"status": "not_generated"
},
"founderFit": {
"status": "not_generated"
},
"playbook": {
"status": "not_generated"
},
"trends": {
"status": "not_generated"
},
"community": {
"status": "not_generated"
}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
},
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"failures": [
{}
],
"modules": {}
}{
"analysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanType": "starter",
"enrichmentMode": "core",
"publish": true,
"reportType": "quick",
"analysisTier": "basic",
"status": "PENDING",
"progressStep": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"resetAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"pollHint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"readyForExport": true,
"exportable": true,
"exportBlockedCode": "REPORT_NOT_FROM_AGENT_RUN",
"exportBlockedHint": "<string>",
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"modules": {
"proofOfDemand": {
"status": "not_generated"
},
"founderFit": {
"status": "not_generated"
},
"playbook": {
"status": "not_generated"
},
"trends": {
"status": "not_generated"
},
"community": {
"status": "not_generated"
}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
},
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"failures": [
{}
],
"modules": {}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Analyses
Enrich an analysis
Idempotently generates the missing core export sections for a COMPLETED run THIS API started. A report created on the preuve.ai dashboard is refused with 403 REPORT_NOT_FROM_AGENT_RUN, like the export: polling resolves it, generating against it does not. Optionally starts deep-only modules via body.modules (one successful generation per module per report). founderFit runs inline and underwrites against the founder profile saved on preuve.ai when founderProfile is omitted (an explicit payload overrides it); the other modules run async - poll get_analysis. Partial failures return HTTP 207 with a success-shaped body.
POST
/
api
/
agent
/
analyses
/
{id}
/
enrich
Enrich an analysis
curl --request POST \
--url https://preuve.ai/api/agent/analyses/{id}/enrich \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"modules": [
"founderFit",
"playbook"
],
"founderProfile": {
"hoursPerWeek": 20,
"runwayMonths": 6,
"domainYears": 3,
"shippedBefore": "side_project",
"audienceSize": "under_1k",
"teamStatus": "solo"
}
}
'import requests
url = "https://preuve.ai/api/agent/analyses/{id}/enrich"
payload = {
"modules": ["founderFit", "playbook"],
"founderProfile": {
"hoursPerWeek": 20,
"runwayMonths": 6,
"domainYears": 3,
"shippedBefore": "side_project",
"audienceSize": "under_1k",
"teamStatus": "solo"
}
}
headers = {
"x-preuve-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-preuve-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
modules: ['founderFit', 'playbook'],
founderProfile: {
hoursPerWeek: 20,
runwayMonths: 6,
domainYears: 3,
shippedBefore: 'side_project',
audienceSize: 'under_1k',
teamStatus: 'solo'
}
})
};
fetch('https://preuve.ai/api/agent/analyses/{id}/enrich', 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://preuve.ai/api/agent/analyses/{id}/enrich",
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([
'modules' => [
'founderFit',
'playbook'
],
'founderProfile' => [
'hoursPerWeek' => 20,
'runwayMonths' => 6,
'domainYears' => 3,
'shippedBefore' => 'side_project',
'audienceSize' => 'under_1k',
'teamStatus' => 'solo'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-preuve-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://preuve.ai/api/agent/analyses/{id}/enrich"
payload := strings.NewReader("{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-preuve-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://preuve.ai/api/agent/analyses/{id}/enrich")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses/{id}/enrich")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-preuve-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"modules\": [\n \"founderFit\",\n \"playbook\"\n ],\n \"founderProfile\": {\n \"hoursPerWeek\": 20,\n \"runwayMonths\": 6,\n \"domainYears\": 3,\n \"shippedBefore\": \"side_project\",\n \"audienceSize\": \"under_1k\",\n \"teamStatus\": \"solo\"\n }\n}"
response = http.request(request)
puts response.read_body{
"analysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanType": "starter",
"enrichmentMode": "core",
"publish": true,
"reportType": "quick",
"analysisTier": "basic",
"status": "PENDING",
"progressStep": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"resetAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"pollHint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"readyForExport": true,
"exportable": true,
"exportBlockedCode": "REPORT_NOT_FROM_AGENT_RUN",
"exportBlockedHint": "<string>",
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"modules": {
"proofOfDemand": {
"status": "not_generated"
},
"founderFit": {
"status": "not_generated"
},
"playbook": {
"status": "not_generated"
},
"trends": {
"status": "not_generated"
},
"community": {
"status": "not_generated"
}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
},
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"failures": [
{}
],
"modules": {}
}{
"analysis": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanType": "starter",
"enrichmentMode": "core",
"publish": true,
"reportType": "quick",
"analysisTier": "basic",
"status": "PENDING",
"progressStep": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"resetAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"pollHint": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"readyForExport": true,
"exportable": true,
"exportBlockedCode": "REPORT_NOT_FROM_AGENT_RUN",
"exportBlockedHint": "<string>",
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"modules": {
"proofOfDemand": {
"status": "not_generated"
},
"founderFit": {
"status": "not_generated"
},
"playbook": {
"status": "not_generated"
},
"trends": {
"status": "not_generated"
},
"community": {
"status": "not_generated"
}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
},
"enrichment": {
"mode": "core",
"status": "not_required",
"required": [
"<string>"
],
"completed": [
"<string>"
],
"missing": [
"<string>"
],
"processing": [
"<string>"
],
"failed": [
"<string>"
],
"sections": {}
},
"failures": [
{}
],
"modules": {}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"paused": true,
"upsell": {
"offer": "founder_report",
"price": "<string>",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Authorizations
Your API key (prv_...), sent as-is. It is the only credential the API needs - see the Authentication guide.
Path Parameters
Run id (returned by create) or report id. What resolves differs per route: the poll also accepts any personal starter or deep report the account owns, including dashboard-created ones (the UUID in /app/results?id=...), while export and enrich serve analyses this API started. See each operation.
Body
application/json
Response
Enrichment (and any inline module) completed.
Show child attributes
Show child attributes
Progress of the core export sections. The four name arrays partition required, so a poller decides what to do next by reading them rather than by parsing status: anything in processing means keep polling, anything in failed means call enrich again, and missing with nothing processing means enrichment was never started for it.
Show child attributes
Show child attributes
Core sections that failed this pass. Retry by calling enrich again.
Per-module results for the modules requested in this call.
Show child attributes
Show child attributes