Skip to main content
POST
Start a client project

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.

Body

application/json
clientRunId
string
required

Idempotency key, scoped to the calling API key.

Maximum string length: 200
idea
string
required
Required string length: 40 - 50000
targetMarket
string
Maximum string length: 180
targetCountry
string
default:global
Maximum string length: 80
stage
string
Maximum string length: 80
budget
string
Maximum string length: 80
language
string
default:en
Maximum string length: 12
scanType
enum<string>

Optional and deep-only. An Agency project always spends one shared deep project credit; any other value is 400 INVALID_SCAN_TYPE.

Available options:
deep
publish
enum<boolean>

Not accepted here. Client share links are created in the Agency dashboard; publish=true is 400 INVALID_INPUT.

Available options:
false

Response

Existing report replayed via clientRunId (reused=true).

reportId
string
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
scanType
enum<string>
Available options:
starter,
deep
analysisTier
string
readyForExport
boolean
reportUrl
string<uri>
createdAt
string<date-time>
pollAfterSeconds
integer

Present only while the report is not terminal.

reused
boolean

Present when this clientRunId replayed an existing report.

dispatchPending
boolean

The dispatch outcome is unknown. Retry the same clientRunId and arguments after 60 seconds; recovery reuses the original report and credit. Past 23 hours the recovery text directs you to support instead of risking a duplicate job.

recovery
string

What to do next, present alongside dispatchPending.