Start a batch
curl --request POST \
--url https://preuve.ai/api/agent/analysis-batches \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"clientRunId": "<string>",
"items": [
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "<string>",
"title": "<string>",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"enrichmentMode": "core",
"publish": true
}
],
"name": "<string>"
}
'import requests
url = "https://preuve.ai/api/agent/analysis-batches"
payload = {
"clientRunId": "<string>",
"items": [
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "<string>",
"title": "<string>",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"enrichmentMode": "core",
"publish": True
}
],
"name": "<string>"
}
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: '<string>',
items: [
{
clientRunId: '<string>',
idea: '<string>',
targetMarket: '<string>',
targetCountry: '<string>',
title: '<string>',
stage: '<string>',
budget: '<string>',
language: 'en',
enrichmentMode: 'core',
publish: true
}
],
name: '<string>'
})
};
fetch('https://preuve.ai/api/agent/analysis-batches', 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/analysis-batches",
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>',
'items' => [
[
'clientRunId' => '<string>',
'idea' => '<string>',
'targetMarket' => '<string>',
'targetCountry' => '<string>',
'title' => '<string>',
'stage' => '<string>',
'budget' => '<string>',
'language' => 'en',
'enrichmentMode' => 'core',
'publish' => true
]
],
'name' => '<string>'
]),
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/analysis-batches"
payload := strings.NewReader("{\n \"clientRunId\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\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/analysis-batches")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analysis-batches")
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\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"name": "<string>",
"status": "<string>",
"counts": {},
"items": [
{
"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>"
}
]
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"name": "<string>",
"status": "<string>",
"counts": {},
"items": [
{
"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>"
}
]
}{
"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>"
}
}Batches
Start a batch
Create up to 5 analysis runs in one batch. Idempotent on the batch clientRunId. Each item needs its own unique clientRunId. Item scanType is optional and falls back to the batch’s, so set it per item only to mix starter and deep in one batch.
POST
/
api
/
agent
/
analysis-batches
Start a batch
curl --request POST \
--url https://preuve.ai/api/agent/analysis-batches \
--header 'Content-Type: application/json' \
--header 'x-preuve-key: <api-key>' \
--data '
{
"clientRunId": "<string>",
"items": [
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "<string>",
"title": "<string>",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"enrichmentMode": "core",
"publish": true
}
],
"name": "<string>"
}
'import requests
url = "https://preuve.ai/api/agent/analysis-batches"
payload = {
"clientRunId": "<string>",
"items": [
{
"clientRunId": "<string>",
"idea": "<string>",
"targetMarket": "<string>",
"targetCountry": "<string>",
"title": "<string>",
"stage": "<string>",
"budget": "<string>",
"language": "en",
"enrichmentMode": "core",
"publish": True
}
],
"name": "<string>"
}
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: '<string>',
items: [
{
clientRunId: '<string>',
idea: '<string>',
targetMarket: '<string>',
targetCountry: '<string>',
title: '<string>',
stage: '<string>',
budget: '<string>',
language: 'en',
enrichmentMode: 'core',
publish: true
}
],
name: '<string>'
})
};
fetch('https://preuve.ai/api/agent/analysis-batches', 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/analysis-batches",
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>',
'items' => [
[
'clientRunId' => '<string>',
'idea' => '<string>',
'targetMarket' => '<string>',
'targetCountry' => '<string>',
'title' => '<string>',
'stage' => '<string>',
'budget' => '<string>',
'language' => 'en',
'enrichmentMode' => 'core',
'publish' => true
]
],
'name' => '<string>'
]),
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/analysis-batches"
payload := strings.NewReader("{\n \"clientRunId\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\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/analysis-batches")
.header("x-preuve-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientRunId\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/analysis-batches")
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\": \"<string>\",\n \"items\": [\n {\n \"clientRunId\": \"<string>\",\n \"idea\": \"<string>\",\n \"targetMarket\": \"<string>\",\n \"targetCountry\": \"<string>\",\n \"title\": \"<string>\",\n \"stage\": \"<string>\",\n \"budget\": \"<string>\",\n \"language\": \"en\",\n \"enrichmentMode\": \"core\",\n \"publish\": true\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"name": "<string>",
"status": "<string>",
"counts": {},
"items": [
{
"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>"
}
]
}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"clientRunId": "<string>",
"name": "<string>",
"status": "<string>",
"counts": {},
"items": [
{
"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>"
}
]
}{
"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.
Body
application/json
- scanType set for the whole batch
- scanType set on every item
Idempotency id for the whole batch.
Default scanType applied to every item; each item may override.
Available options:
starter, deep Required array length:
1 - 5 elementsShow child attributes
Show child attributes
Available options:
core, none Response
Existing batch replayed via clientRunId. Nothing new was created and nothing new was consumed; the body is the batch's current state.