Supporting APIs

Download Report

Downloads the generated report in the required format. Supported formats: pdf, docx, and json.

  • For json format, the response body contains the structured report data.
  • For pdf and docx, the response contains the binary file content.
post/api/assets/download_report/

Request

  • Base URL: https://api.wokelo.ai
  • URL: https://api.wokelo.ai/api/assets/download_report/
  • Auth: HTTP bearer

Request body

report_idinteger required

ID of the report to be exported.

file_type'pdf' | 'docx' | 'json' required

Export format.

Example request

{
  "report_id": 84102,
  "file_type": "json"
}

Response

Report downloaded successfully. Returns binary file for pdf/docx, or structured JSON data for json format.

object required

Structured report data (returned only when file_type is json).

Changes

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