FilePreviews

FREE
By raygorodskij
Updated 8 months ago
Video, Images
4.3/10
Popularity Score
238ms
Latency
100%
Success Rate

FilePreviews API Documentation

FilePreviews is an API that produces beautiful previews,optical character recognition and metadata from any file.

View API Details
POSTcreatePreview
POSTgetPreview
POSTwebhookEvent
POSTcreatePreview

Create file preview.Returned response can be used for polling until results are available and return an HTTP status code of 200. If application has a Callback URL specified, results will also be posted via webhooks.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
apiSecretCREDENTIALS
REQUIREDYour API secret.
fileUrlSTRING
REQUIREDFile url to preview.
apiKeyCREDENTIALS
REQUIREDYour API key.
Optional Parameters
sizesLIST
OPTIONALAn array of sizes of the extracted thumbnails, in pixels. Expressed as widthxheight. Specifying only the width(e.g `300`) will generate a thumbnail with a fixed width and varying height. You can also only shrink larger images to fit into the give size and never enlarge(e.g `300x400>`).
metadataLIST
OPTIONALAn list of string values of additional metadata to extract.
formatSELECT
OPTIONALThe format of the extracted thumbnails.
pagesSTRING
OPTIONALThe document pages that you want to extract thumbnails for. You can specify a range or individual pages separated by commas. Example: `1-3` or `1,3,5`. You can also specify the special value of `all` to extract all pages. Default value is `1`.
callbackUrlSTRING
OPTIONALA URL that we will POST anytime results for requests previews are ready.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication