Skip to main content
POST
Start an analysis

Authorizations

x-preuve-key
string
header
required

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

application/json
clientRunId
string
required

Caller-chosen idempotency id. Reusing it replays the existing run.

scanType
enum<string>
required

"free" costs nothing; "deep" runs the full paid analysis and consumes account quota.

Available options:
free,
deep
idea
string
required

The startup idea, in plain language.

targetMarket
string
targetCountry
string

ISO country code, e.g. "US" or "FR".

title
string
stage
string
budget
string
language
string
default:en
enrichmentMode
enum<string>
default:core

"core" also generates the export-required sections; "none" returns the raw completion only.

Available options:
core,
none
publish
boolean

When true, creates a public share URL for the report.

Response

Run created (or replayed via clientRunId).

id
string<uuid>
reportId
string<uuid>
clientRunId
string
scanType
enum<string>

Your request type. Reliable from creation, even while PROCESSING.

Available options:
free,
deep
reportType
enum<string>
Available options:
quick,
deep_dive
analysisTier
enum<string>

Derived from the report. Deep runs read "basic" until deep sections land.

Available options:
basic,
advanced
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
readyForExport
boolean
enrichment
object
modules
object | null

Per-module statuses. Deep reports only; null on free runs.

reportUrl
string<uri>
shareUrl
string<uri> | null