Export a batch (ideas-json)

curl --request GET \
  --url https://preuve.ai/api/agent/analysis-batches/{batchId}/export \
  --header 'x-preuve-key: <api-key>'

const options = {method: 'GET', headers: {'x-preuve-key': '<api-key>'}};

fetch('https://preuve.ai/api/agent/analysis-batches/{batchId}/export', 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/{batchId}/export",
  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/analysis-batches/{batchId}/export"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://preuve.ai/api/agent/analysis-batches/{batchId}/export")

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

{
  "schemaVersion": 2,
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exportedAt": "2023-11-07T05:31:56Z",
  "verbosity": "full",
  "locked": {
    "reason": "<string>",
    "unlockedBy": "<string>",
    "fields": [
      {
        "path": "<string>",
        "label": "<string>"
      }
    ],
    "note": "<string>"
  },
  "upsell": {
    "offer": "founder_report",
    "price": "<string>",
    "guarantee": "<string>",
    "url": "<string>",
    "locked": [
      "<string>"
    ],
    "note": "<string>"
  },
  "counts": {
    "total": 123,
    "exported": 123,
    "omitted": 123
  },
  "ideas": [
    {}
  ],
  "omittedItems": [
    {
      "id": "<string>",
      "clientRunId": "<string>",
      "reportId": "<string>",
      "status": "<string>",
      "reason": "<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>"
  }
}

GET

api

agent

analysis-batches

{batchId}

export

Export a batch (ideas-json)

curl --request GET \
  --url https://preuve.ai/api/agent/analysis-batches/{batchId}/export \
  --header 'x-preuve-key: <api-key>'

const options = {method: 'GET', headers: {'x-preuve-key': '<api-key>'}};

fetch('https://preuve.ai/api/agent/analysis-batches/{batchId}/export', 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/{batchId}/export",
  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/analysis-batches/{batchId}/export"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://preuve.ai/api/agent/analysis-batches/{batchId}/export")

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

{
  "schemaVersion": 2,
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "exportedAt": "2023-11-07T05:31:56Z",
  "verbosity": "full",
  "locked": {
    "reason": "<string>",
    "unlockedBy": "<string>",
    "fields": [
      {
        "path": "<string>",
        "label": "<string>"
      }
    ],
    "note": "<string>"
  },
  "upsell": {
    "offer": "founder_report",
    "price": "<string>",
    "guarantee": "<string>",
    "url": "<string>",
    "locked": [
      "<string>"
    ],
    "note": "<string>"
  },
  "counts": {
    "total": 123,
    "exported": 123,
    "omitted": 123
  },
  "ideas": [
    {}
  ],
  "omittedItems": [
    {
      "id": "<string>",
      "clientRunId": "<string>",
      "reportId": "<string>",
      "status": "<string>",
      "reason": "<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

x-preuve-key

string

header

required

Your API key (prv_...), sent as-is. It is the only credential the API needs - see the Authentication guide.

Path Parameters

batchId

string<uuid>

required

Batch id returned by create.

Query Parameters

format

enum<string>

default:ideas-json

Available options:

ideas-json

verbosity

enum<string>

default:full

Response size, applied to every idea in the batch. Same two values and the same wire default as the single-analysis export ("full" when the parameter is omitted), but send "summary" here: a batch multiplies one report by up to five, and a full batch of deep reports will not fit a tool-result limit. "summary" drops section prose (keeping the closing verdict under details.sections.synthesis) and the Google Trends data points and lists what it left out under details.omitted on each idea.

Available options:

full,

summary

Response

The batch export payload.

Note the asymmetry with the other two exports: this one carries no exportType. The single-analysis and agency-report exports each stamp one, this payload identifies itself by batchId instead, and the schema follows the wire rather than inventing a discriminator that is never sent.

schemaVersion

integer

batchId

string<uuid>

The batch this export was built from.

exportedAt

string<date-time>

verbosity

enum<string>

The verbosity every idea in this payload was built at, echoed back. On "summary", each idea's details.omitted names what was dropped.

Available options:

full,

summary

locked

object

Which fields this export left null, and why. Present only when the caller's tier withheld something, and absent entirely when the payload is complete. Read it before concluding a field is absent: a null under one of these paths is locked, not missing and not a failed analysis. It ships to every tier, paid included, and carries no price and no URL. On a batch export there is ONE object for the whole batch, the union of every exported item's withheld fields, deduplicated by path.

Show child attributes

upsell

object

Purchase context for a locked export or buyable quota refusal. Export upsells are free-owner only; a paid non-regional caller may receive a scan_pack top-up on INSUFFICIENT_TOKENS. Ignore it if you only need the data contract.

Show child attributes

counts

object

The batch's own item tally (total, plus one key per item status such as COMPLETED or FAILED) with the export's two counts merged on top. Read the named keys; do not assume the set is closed.

Show child attributes

ideas

object[]

omittedItems

object[]

Every incomplete item with the reason it was skipped.

Show child attributes

API Reference

Endpoints

Export a batch (ideas-json)

Authorizations

Path Parameters

Query Parameters

Response