API Documentation | Clean File API Reference

This defines to generate the preview of the file API:

Request - to generate p[review of the file.
Response - ensure that your request to the File Preview Generate API was successful.

Request

A File Preview Generate API request looks like:

http://fax.to/api/v2/file-generate-preview?document_id=DOCUMENT_ID&api_key=API_KEY

This request contains:

The following table shows the parameters you use in the request:

Parameter	Description	Required
document_id	Your document_id. For example `document_id=333`.	Yes.

The following table shows the information for authentication:

Parameter	Description	Required
api_key	Your Key. For example, `api_key=f@x2r0ckkz`.	Yes.

You find your Key in Dashboard.

To ensure privacy, you must use HTTPS for all Faxto API requests.

You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values.

We support JSON ONLY responses


{
      "status": "success",
      "url": "http:\\api.fax.dev\member\my-documents\show-file\preview.png"
    }

Key	Value	Response Type
status	The status of the API request	JSON