Export

Export simulation run results

Export a simulation run in the requested format.

FormatContent-TypeDependency
csvtext/csvstdlib — always available
xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheetopenpyxl
pdfapplication/pdffpdf2
jsonapplication/jsonstdlib — always available

If the optional dependency is not installed the endpoint returns 503.

get/v1/runs/{run_id}/export.{fmt}

Request

  • Base URL: https://api.algenta.ai
  • URL: https://api.algenta.ai/v1/runs/{run_id}/export.{fmt}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

run_idstring uuid required

Simulation run UUID

fmtstring required

Export format: csv | xlsx | pdf | json

Response

Export file bytes

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.