v2

latestOpenAPI 3.0.12026-07-266846393.5 KB
Document, File & System

Get MD5 Hash of File by URL

Calculate and return MD5 hash of file by url. Commonly used to control if the source document has been changed or not because every little change will cause hash string to differ as well.

post/v1/file/hash

Request body

urlstring uri required

URL to the source file url attribute.

httpusernamestring

HTTP auth user name if required to access source URL.

httppasswordstring

HTTP auth password if required to access source URL.

Response

Success.

statusstring

Status of the API response.

messagestring

Descriptive message for the response status.

urlstring uri

URL to the output file.

jobIdstring

Unique identifier for the job.

creditsinteger

Credits used for this operation.

remainingCreditsinteger

Credits remaining after this operation.

durationinteger

Time taken to complete the request, in milliseconds.

Example response

{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}