Skip to main content
GET
Export a batch (ideas-json)

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 ten, and a full batch of deep reports will not fit a tool-result limit. The export_batch MCP tool sends "summary" for that reason unless the caller asks for "full". "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.

schemaVersion
integer
exportType
enum<string>
Available options:
batch
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.

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.

counts
object
ideas
object[]
omittedItems
object[]

Every incomplete item with the reason it was skipped.