Parsing API

Create an upload URL

Create a signed upload URL for a source file. Upload the file with HTTP PUT, then use the returned fileKey when you queue a batch.

post/parser/upload-url

Request

  • Base URL: https://contracko.com/api/v1
  • URL: https://contracko.com/api/v1/parser/upload-url
  • Auth: one of:
    • API key in header x-contracko-api-key
    • HTTP bearer

Request body

fileNamestring required

Original file name including extension

mimeTypestring required

RFC MIME type of the source file

fileSizeinteger required

File size in bytes

pageCountEstimateinteger

Optional page count estimate to improve credit estimation

Response

Upload URL returned.

fileKeystring required

File reference to include in POST /parser/jobs

uploadUrlstring required

Single-use signed URL for file upload

expiresIninteger required

Number of seconds until URL expiration

creditsinteger required

Estimated credits for this file

Changes

No recorded changes to this operation across all 1 revision of this API.