curl --request POST \
--url https://preuve.ai/api/agent/agency/analyses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "global",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"scanType": "deep",
"publish": false
}
'import requests
url = "https://preuve.ai/api/agent/agency/analyses"
payload = {
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "global",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"scanType": "deep",
"publish": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientRunId: '<string>',
idea: '<string>',
targetMarket: '<string>',
targetCountry: 'global',
stage: '<string>',
budget: '<string>',
language: 'en',
scanType: 'deep',
publish: false
})
};
fetch('https://preuve.ai/api/agent/agency/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/agency/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' => '<string>',
'idea' => '<string>',
'targetMarket' => '<string>',
'targetCountry' => 'global',
'stage' => '<string>',
'budget' => '<string>',
'language' => 'en',
'scanType' => 'deep',
'publish' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/agency/analyses"
payload := strings.NewReader("{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/agency/analyses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/agency/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}"
response = http.request(request)
puts response.read_body{
"reportId": "<string>",
"status": "PENDING",
"scanType": "starter",
"analysisTier": "<string>",
"readyForExport": true,
"reportUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"reused": true,
"dispatchPending": true,
"recovery": "<string>"
}{
"reportId": "<string>",
"status": "PENDING",
"scanType": "starter",
"analysisTier": "<string>",
"readyForExport": true,
"reportUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"reused": true,
"dispatchPending": true,
"recovery": "<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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Start a client project
Create one client report. scanType “deep” (the default) spends one shared Agency project credit and never falls back to personal credits. scanType “starter” runs a client Starter Scan that spends no credit: it is open to the workspace owner who holds the AppSumo Tier 4 or 5 licence, under the one fair-use ceiling of 100 Starter Scans per 30 days that the personal app and the Agency dashboard share (429 FAIR_USE_LIMIT past it), and to the owner of a workspace nobody has funded yet, for its one free client scan (409 FREE_SCAN_USED once spent). A Starter Scan shows in the Agency dashboard and in the report list like any client report, and its export answers the starter shape, with the deep-only fields listed under locked. Async: 202 on a new dispatch, 200 with reused=true when the clientRunId replays an existing report. clientRunId is scoped to the calling key; reusing one that belongs to a different workspace is 409 CLIENT_RUN_ID_CONFLICT. A response carrying dispatchPending=true means the dispatch outcome is unknown - retry the same clientRunId and arguments after 60 seconds; recovery reuses the original report and credit. 503 TRIGGER_DISPATCH_FAILED is a definite rejection: the credit was restored and that request stays failed on replay, so a new attempt needs a new clientRunId. Creating a report here does not email the client or publish a share link.
curl --request POST \
--url https://preuve.ai/api/agent/agency/analyses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "global",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"scanType": "deep",
"publish": false
}
'import requests
url = "https://preuve.ai/api/agent/agency/analyses"
payload = {
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "global",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"scanType": "deep",
"publish": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientRunId: '<string>',
idea: '<string>',
targetMarket: '<string>',
targetCountry: 'global',
stage: '<string>',
budget: '<string>',
language: 'en',
scanType: 'deep',
publish: false
})
};
fetch('https://preuve.ai/api/agent/agency/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/agency/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' => '<string>',
'idea' => '<string>',
'targetMarket' => '<string>',
'targetCountry' => 'global',
'stage' => '<string>',
'budget' => '<string>',
'language' => 'en',
'scanType' => 'deep',
'publish' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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/agency/analyses"
payload := strings.NewReader("{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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/agency/analyses")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/agency/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"global\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"scanType\": \"deep\",\n \"publish\": false\n}"
response = http.request(request)
puts response.read_body{
"reportId": "<string>",
"status": "PENDING",
"scanType": "starter",
"analysisTier": "<string>",
"readyForExport": true,
"reportUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"reused": true,
"dispatchPending": true,
"recovery": "<string>"
}{
"reportId": "<string>",
"status": "PENDING",
"scanType": "starter",
"analysisTier": "<string>",
"readyForExport": true,
"reportUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"pollAfterSeconds": 123,
"reused": true,
"dispatchPending": true,
"recovery": "<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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"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>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Authorizations
Body
"deep" spends one shared deep project credit. "starter" runs a client Starter Scan that spends no credit, within the Starter fair use (see the operation). Any other value is 400 INVALID_SCAN_TYPE. A clientRunId replay keeps the scan type it was started with.
deep, starter Response
Existing report replayed via clientRunId (reused=true).