Skip to main content
POST
Generate the intelligence report

Headers

x-api-key
string | null

Path Parameters

investigation_id
string
required

Body

application/json
retry_failed
boolean
default:false

Retry after a failed attempt on the same workspace.

Response

Successful Response

job_id
string
required
status
enum<string>
required

completed means the PDF is downloadable; superseded means the workspace changed and a newer job replaced this one.

Available options:
pending,
running,
completed,
failed,
superseded
workspace_hash
string | null

The workspace snapshot this report covers.

requested_at
string | null
completed_at
string | null
error
string | null
cached
boolean
default:false

True when an up-to-date report already existed.

byte_size
integer
default:0