Sign in

v2

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

Document Classifier

Automatically find class of input PDF, JPG, PNG document by analyzing its content using the built-in AI or custom defined classification rules.

post/v1/pdf/classifier

Request body

filestring path to a local file

The path to the local file to be uploaded.

urlstring uri required

URL to the source file url attribute.

rulescsvstring
rulescsvurlstring
casesensitiveboolean

Set to false to don't use case-sensitive search.

passwordstring

Password for the PDF file.

asyncboolean

Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks

timeoutnumber

Timeout for output links in seconds

profilesstring

Profiles are used configure extra options for specific API endpoints and may be unique to an API. For more information, see Profiles and the documentation of each endpoint for profiles specific to it.

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
}