AISpectra API Details

<Get> Retrieve Artifacts

2min

<Get> Retrieve the report and assets as part of the assessment /api/ais/v1.5/get_report

Report generation API helps generate defense ,vulnerability reports and attack samples. (vulnerability report, defense artifacts,attack_samples). For generating reports, there are three parameters:

GET
Request
Header Parameters
x-api-key
required
String
Enter your API key
Org-id
required
String
Enter your organization id
Body Parameters
job_id
required
String
Enter uniquely created job_id received during model analysis.
report_type
required
String
You can generate different reports (vulnerability, defense and attack_samples)
file_format
required
Number
0 - 4 values can be used to generate the report. 0 = all, 2 = pdf, 3 = json

  • job_id: Uniquely created job_id received during model analysis
  • report_type: parameter to define type of report to download. e.g vulnerability, defense and attack_samples)
  • file_format: value between 0-4, 0 = all,2 = pdf, 3 = json

For using Nodejs sample code, install npm package request

Given ample code for python is tested for Python version 3.7

Given Sample code for nodejs and javascript is tested for Node V20LTS