curl --request POST \
--url https://preuve.ai/api/agent/analyses \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"clientRunId": "my-run-001",
"scanType": "free",
"idea": "A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.",
"targetMarket": "Independent coffee shops",
"targetCountry": "US",
"enrichmentMode": "core",
"publish": true
}
'import requests
url = "https://preuve.ai/api/agent/analyses"
payload = {
"clientRunId": "my-run-001",
"scanType": "free",
"idea": "A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.",
"targetMarket": "Independent coffee shops",
"targetCountry": "US",
"enrichmentMode": "core",
"publish": True
}
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({
clientRunId: 'my-run-001',
scanType: 'free',
idea: 'A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.',
targetMarket: 'Independent coffee shops',
targetCountry: 'US',
enrichmentMode: 'core',
publish: true
})
};
fetch('https://preuve.ai/api/agent/analyses', 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",
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([
'clientRunId' => 'my-run-001',
'scanType' => 'free',
'idea' => 'A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.',
'targetMarket' => 'Independent coffee shops',
'targetCountry' => 'US',
'enrichmentMode' => 'core',
'publish' => true
]),
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"
payload := strings.NewReader("{\n \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\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")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses")
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 \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n}"
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>"
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>"
}Start an analysis
Create one analysis run. Async - poll with GET /api/agent/analyses/. scanType is required and explicit: “free” costs nothing, “deep” consumes paid account quota. clientRunId is your idempotency key: re-POSTing the same value replays the existing run.
curl --request POST \
--url https://preuve.ai/api/agent/analyses \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"clientRunId": "my-run-001",
"scanType": "free",
"idea": "A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.",
"targetMarket": "Independent coffee shops",
"targetCountry": "US",
"enrichmentMode": "core",
"publish": true
}
'import requests
url = "https://preuve.ai/api/agent/analyses"
payload = {
"clientRunId": "my-run-001",
"scanType": "free",
"idea": "A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.",
"targetMarket": "Independent coffee shops",
"targetCountry": "US",
"enrichmentMode": "core",
"publish": True
}
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({
clientRunId: 'my-run-001',
scanType: 'free',
idea: 'A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.',
targetMarket: 'Independent coffee shops',
targetCountry: 'US',
enrichmentMode: 'core',
publish: true
})
};
fetch('https://preuve.ai/api/agent/analyses', 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",
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([
'clientRunId' => 'my-run-001',
'scanType' => 'free',
'idea' => 'A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.',
'targetMarket' => 'Independent coffee shops',
'targetCountry' => 'US',
'enrichmentMode' => 'core',
'publish' => true
]),
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"
payload := strings.NewReader("{\n \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\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")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analyses")
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 \"clientRunId\": \"my-run-001\",\n \"scanType\": \"free\",\n \"idea\": \"A scheduling assistant that helps independent coffee shops coordinate weekly local supplier orders with lower waste.\",\n \"targetMarket\": \"Independent coffee shops\",\n \"targetCountry\": \"US\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n}"
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>"
}{
"error": "<string>",
"code": "<string>",
"details": "<unknown>"
}{
"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.
Body
Caller-chosen idempotency id. Reusing it replays the existing run.
"free" costs nothing; "deep" runs the full paid analysis and consumes account quota.
free, deep The startup idea, in plain language.
ISO country code, e.g. "US" or "FR".
"core" also generates the export-required sections; "none" returns the raw completion only.
core, none When true, creates a public share URL for the report.
Response
Run created (or replayed via clientRunId).
Your request type. Reliable from creation, even while PROCESSING.
free, deep quick, deep_dive Derived from the report. Deep runs read "basic" until deep sections land.
basic, advanced 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