Skip to main content
POST
/
v1
/
reports
Generate PDF Report
curl --request POST \
  --url https://api.gominerva.com/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "searchResultId": "69ba0ba92908cb3209647d38_0",
  "index": 0
}
'
{
  "status": 200,
  "response": "Reports generated",
  "reports": [
    "https://storage.googleapis.com/minervaaisite.appspot.com/B3RFqISn7JN4OSJhie3uF76hUJB3/reports/1628784142759691_57.pdf?GoogleAccessId=firebase-adminsdk-2bfq5%40minervaaisite.iam.gserviceaccount.com&Expires=16468358400&Signature=aamxM%2FRC%2FloClKkzB1tQ6leYyVvQfEIKBslNkFvYjRf7odVGwltVCZEAjvJolB%2BNYGI1M%2BTn4RrAZh5lMBh5TuJnzK9Kn76uGrIBwaOwZJB2G49r%2F%2F%2FEh%2BBBRauYpY4ngAKBJV%2FLJTjQ38RJtiJtJJHSyO%2F2LdpQGzpC10fr1BpjEk6geDAe%2BC1sUaWCwkb3CUP%2FUB6eyV%2Fv3ZaxSMDLQiPAkPa8Zm0p618U4L%2FijpUpefsrGovPT61YC1iqAtypmnrWXKf1npm65%2BTR%2FsofzIpeBUIfVEp5MH3sidhA5gLRyqSqRqQwn0AcGID95vPGBk6kklmdnINu7RGsd7mkmQ%3D%3D"
  ]
}

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:
[
  "69ba0ba92908cb3209647d38_0",
  "69ba0ba92908cb3209647d38_1"
]
​
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:
[
  "https://storage.googleapis.com/minervaaisite.appspot.com/B3RFqISn7JN4OSJhie3uF76hUJB3/reports/1628784142759691_57.pdf?GoogleAccessId=firebase-adminsdk-2bfq5%40minervaaisite.iam.gserviceaccount.com&Expires=16468358400&Signature=aamxM%2FRC%2FloClKkzB1tQ6leYyVvQfEIKBslNkFvYjRf7odVGwltVCZEAjvJolB%2BNYGI1M%2BTn4RrAZh5lMBh5TuJnzK9Kn76uGrIBwaOwZJB2G49r%2F%2F%2FEh%2BBBRauYpY4ngAKBJV%2FLJTjQ38RJtiJtJJHSyO%2F2LdpQGzpC10fr1BpjEk6geDAe%2BC1sUaWCwkb3CUP%2FUB6eyV%2Fv3ZaxSMDLQiPAkPa8Zm0p618U4L%2FijpUpefsrGovPT61YC1iqAtypmnrWXKf1npm65%2BTR%2FsofzIpeBUIfVEp5MH3sidhA5gLRyqSqRqQwn0AcGID95vPGBk6kklmdnINu7RGsd7mkmQ%3D%3D"
]