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"
}
'
import requests

url = "https://api.parcha.ai/api/v1/downloadReport"

payload = {
"case_id": "<string>",
"agent_key": "<string>",
"force_refresh_report": False,
"download_test_report": False,
"report_version": "v1"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
case_id: '<string>',
agent_key: '<string>',
force_refresh_report: false,
download_test_report: false,
report_version: 'v1'
})
};

fetch('https://api.parcha.ai/api/v1/downloadReport', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parcha.ai/api/v1/downloadReport",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'case_id' => '<string>',
'agent_key' => '<string>',
'force_refresh_report' => false,
'download_test_report' => false,
'report_version' => 'v1'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.parcha.ai/api/v1/downloadReport"

payload := strings.NewReader("{\n \"case_id\": \"<string>\",\n \"agent_key\": \"<string>\",\n \"force_refresh_report\": false,\n \"download_test_report\": false,\n \"report_version\": \"v1\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.parcha.ai/api/v1/downloadReport")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"case_id\": \"<string>\",\n \"agent_key\": \"<string>\",\n \"force_refresh_report\": false,\n \"download_test_report\": false,\n \"report_version\": \"v1\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.parcha.ai/api/v1/downloadReport")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"case_id\": \"<string>\",\n \"agent_key\": \"<string>\",\n \"force_refresh_report\": false,\n \"download_test_report\": false,\n \"report_version\": \"v1\"\n}"

response = http.request(request)
puts response.read_body
"<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.