Poll an analysis
curl --request GET \
--url https://preuve.ai/api/agent/analyses/{id} \
--header 'x-preuve-key: <api-key>'import requests
url = "https://preuve.ai/api/agent/analyses/{id}"
headers = {"x-preuve-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-preuve-key': '<api-key>'}};
fetch('https://preuve.ai/api/agent/analyses/{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://preuve.ai/api/agent/analyses/{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-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"
"net/http"
"io"
)
func main() {
url := "https://preuve.ai/api/agent/analyses/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-preuve-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://preuve.ai/api/agent/analyses/{id}")
.header("x-preuve-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-preuve-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"readyForExport": true,
"enrichment": {
"required": [
"<string>"
],
"completed": [
"<string>"
]
},
"modules": {
"proofOfDemand": {},
"founderFit": {},
"playbook": {},
"trends": {}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>"
}Analyses
Poll an analysis
Returns run status, readyForExport, enrichment progress, per-module statuses (deep runs), and report/share URLs. Accepts the run id or the report id. Does not return the report payload - use export.
GET
/
api
/
agent
/
analyses
/
{id}
Poll an analysis
curl --request GET \
--url https://preuve.ai/api/agent/analyses/{id} \
--header 'x-preuve-key: <api-key>'import requests
url = "https://preuve.ai/api/agent/analyses/{id}"
headers = {"x-preuve-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-preuve-key': '<api-key>'}};
fetch('https://preuve.ai/api/agent/analyses/{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://preuve.ai/api/agent/analyses/{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-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"
"net/http"
"io"
)
func main() {
url := "https://preuve.ai/api/agent/analyses/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-preuve-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://preuve.ai/api/agent/analyses/{id}")
.header("x-preuve-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-preuve-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"readyForExport": true,
"enrichment": {
"required": [
"<string>"
],
"completed": [
"<string>"
]
},
"modules": {
"proofOfDemand": {},
"founderFit": {},
"playbook": {},
"trends": {}
},
"reportUrl": "<string>",
"shareUrl": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>"
}Authorizations
API key id. Requests are additionally signed with x-preuve-timestamp, x-preuve-nonce, and x-preuve-signature (HMAC-SHA256) - see the Authentication guide.
Path Parameters
Run id (returned by create) or report id.
Response
Current run state.
Your request type. Reliable from creation, even while PROCESSING.
Available options:
free, deep Available options:
quick, deep_dive Derived from the report. Deep runs read "basic" until deep sections land.
Available options:
basic, advanced Available options:
PENDING, PROCESSING, COMPLETED, FAILED Show child attributes
Show child attributes
Per-module statuses. Deep reports only; null on free runs.
Show child attributes
Show child attributes
⌘I