View Research Reports
Retrieve and download research report files and documents.
GET/3.0/research/reports/file
Description
This endpoint allows retrieval and download of research report files in their original format (typically PDF). Files are retrieved using the research report ID.
Request
Authentication
- Type: Bearer Token
- Required: Yes
Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
research_id | string | Yes | Research report ID | 64ad34123c85e1d1d902c9b8 |
Response
Success Response (200)
Returns the file content with appropriate content-type headers:
- Content-Type: application/pdf (or appropriate MIME type)
- Content-Disposition: attachment; filename="research_report.pdf"
Response Example
[Binary PDF file content]
Response Fields
This endpoint returns the raw file as a binary stream rather than a JSON body. The response is described by the following:
| Field | Type | Description |
|---|---|---|
Content-Type | string (header) | MIME type of the file (typically application/pdf) |
Content-Disposition | string (header) | attachment with the report's filename |
| Response body | binary | Raw file content of the research report |
Error Responses
For detailed Common Error responses, see the Error Handling.
Missing Research ID (200)
{
"status": "error",
"message": "no `research_id` provided"
}
Invalid Research ID (200)
{
"status": "error",
"message": "invalid `research_id` provided"
}
Invalid File (200)
{
"status": "error",
"message": "invalid file"
}
Examples
Download Report by ID
curl -X GET "https://csapis.com/3.0/research/reports/file?research_id=64ad34123c85e1d1d902c9b8" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-o "research_report.pdf"
Use Cases
- Report Access: Download research reports for offline reading
- Report Distribution: Share research reports with stakeholders
- Document Management: Retrieve and archive research documents
- Report Analysis: Access full reports for detailed analysis