Skip to main content
POST
/
downloadReport
Download report
curl --request POST \
  --url https://api.parcha.ai/api/v1/downloadReport \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "case_id": "<string>",
  "agent_key": "<string>",
  "force_refresh_report": false,
  "download_test_report": false,
  "report_version": "v1"
}
'
"<string>"

Authorizations

​
Authorization
string
header
required

API key obtained from your Parcha account settings. Include as Bearer token in the Authorization header.

Body

application/json
​
case_id
string
required

The unique identifier of the case

​
agent_key
string
required

The key of the agent to use for generating the report

​
force_refresh_report
boolean
default:false

If true, forces regeneration of the report even if cached

​
download_test_report
boolean
default:false

If true, returns a placeholder test report (useful for testing the endpoint)

​
report_version
enum<string>
default:v1

The report version to use. Use "v2" for the latest Parcha 2.0 report format with enhanced styling and layout.

Available options:
v1,
v2

Response

Report downloaded successfully

The response is of type file.