Skip to main content
POST
Generate PDF Report

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Body

application/json
searchResultId
string
required

Recommended. Pass the searchId returned by POST /v1/search-sync, or a result-level searchId returned by POST /v1/searchStatus or GET /v1/search/{jobid}. A plain 24-character request id is treated as the first entity in that request; entity-scoped batch ids use the <requestId>_<entityIndex> format.

Example:

"69ba0b732908cb3209647d36"

results
string[]

Legacy bulk input. Provide one or more result IDs from POST /v1/searchStatus or GET /v1/search/{jobid} to generate multiple reports in a single request.

Example:
index

Potential match index to include in the PDF. Defaults to 0 when omitted. When using the recommended searchResultId flow, pass a single integer. Legacy bulk requests may also pass an array aligned with results.

Example:

0

id
string

Legacy job ID fallback from the original POST /v1/search submission. If you omit searchResultId, Minerva can still resolve the matching request from this job ID.

Example:

"25e15c07-1322-4364-a26e-2a6ef25c81d4"

Response

Reports generated successfully. Returns links to the generated PDFs in cloud storage.

status
number
Example:

200

response
string
Example:

"Reports generated"

reports
string[]

Array of URLs to the generated PDF reports in cloud storage

Example: