Skip to main content

View Research Thumbnails

Retrieve thumbnail images for research reports.

GET/3.0/research/reports/thumbnail

Description

This endpoint retrieves thumbnail images for research reports using the thumbnail file path (as returned in a report's thumbnail field). Thumbnails can be used for preview display in UI applications or research browsing interfaces.

Request

Authentication

  • Type: Bearer Token
  • Required: Yes

Parameters

NameTypeRequiredDescriptionExample
pathstringYesThumbnail file path (as returned in a report's thumbnail field)64ad34123c85e1d1d902c9b8/thumbnail.jpg

Response

Success Response (200)

Returns the thumbnail image with appropriate headers:

  • Content-Type: image/jpeg, image/png (depending on format)
  • Content-Disposition: inline; filename="report_thumbnail.jpg"

Response Example

[Binary image file content]

Response Fields

This endpoint returns the raw image as a binary stream rather than a JSON body. The response is described by the following:

FieldTypeDescription
Content-Typestring (header)MIME type of the image (e.g. image/jpeg, image/png)
Content-Dispositionstring (header)inline with the thumbnail filename
Response bodybinaryRaw thumbnail image content

Error Responses

For detailed Common Error responses, see the Error Handling.

Missing Path (200)

{
"status": "error",
"message": "no `path` provided"
}

Examples

Get Thumbnail by Path

curl -X GET "https://csapis.com/3.0/research/reports/thumbnail?path=64ad34123c85e1d1d902c9b8/thumbnail.jpg" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-o "report_thumbnail.jpg"

Use Cases

  • Report Preview: Display thumbnail for report preview in UI
  • Research Browsing: Use thumbnails in research browsing interfaces
  • Report Listing: Show thumbnails in research report listings
  • Visual Preview: Quick visual identification of reports