Skip to main content
POST
/
v1
/
reports
Generate PDF Report
curl --request POST \
  --url https://api.minervaai.io/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "results": [
    "1624676726659826"
  ],
  "index": [
    0
  ],
  "id": "25e15c07-1322-4364-a26e-2a6ef25c81d4"
}
'
{
  "status": 200,
  "message": "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 uuidv4 API key associated with the MinervaAI account making the request.

Body

application/json
​
results
string[]
required

An array of result ID strings obtained from the request id fields of the response from a previous /searchStatus call. Each result ID will trigger an independent PDF generation task, and all generated PDFs will be returned in a 1-to-1 array corresponding to this parameter.

Example:
["1624676726659826"]
​
id
string
required

The job ID obtained from the initial call to /search that created the scanning task. This will be used to find the previous job under your account and reference the correct result set.

Example:

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

​
index
number[]

An array of index numbers indicating which profile should be used per result set. If this is not provided, then a PDF report will be generated for the first (top) results only. If it is provided, then this will override that behaviour and generate a PDF for the nth index of each result in the order of the array. This array must match the length of the results field.

Example:
[0]

Response

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

​
status
number
Example:

200

​
message
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"
]