Skip to main content

Run Analysis API

Endpoints​

POST /api/run-analysis​

Receives compressed and encoded Analyses Settings. See Request Setup .
Returns compressed and encoded analysis results. See Results Decoding.

URL: /api/run-analysis

Method: POST

Headers:

  • x-api-key: <YOUR_API_KEY>
  • Content-Type: text/plain
  • X-Infrared-Encoding: gzip

Body:<ANALYSIS_SETTINGS_OBJECT> stringified, gzip compressed and base64 encoded

Postman Collection​

You can download here a Postman Collection containing everything you need to run your first requests.

info

The run-analysis request contains pre and post-request scripts that handle gzip and base64 convertions. That is made for the user's convinience, so that they only interact with human readable JSON.