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

Document Classifier

cURL

curl --request POST \
  --url https://api.pdf.co/v1/pdf/classifier \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf",
  "rulescsv": "<string>",
  "rulescsvurl": "<string>",
  "casesensitive": true,
  "password": "<string>",
  "async": false,
  "profiles": "<string>",
  "httpusername": "<string>",
  "httppassword": "<string>"
}
'

200

{
  "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
}

Authorizations

x-api-key · string · header · required

Body

application/json

url · string<uri> · default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf · required

URL to the source file url attribute.

rulescsv · string

rulescsvurl · string

casesensitive · boolean · default: true

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

password · string

Password for the PDF file.

async · boolean · default: false

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

profiles · string

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.

httpusername · string

HTTP auth user name if required to access source URL.

httppassword · string

HTTP auth password if required to access source URL.

Response

200

application/json

Success.

status · string

Status of the API response.

Example:

"success"

message · string

Descriptive message for the response status.

Example:

"Success"

url · string<uri>

URL to the output file.

Example:

"https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf"

jobId · string

Unique identifier for the job.

Example:

"6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA"

credits · integer

Credits used for this operation.

Example:

2

remainingCredits · integer

Credits remaining after this operation.

Example:

1480582

duration · integer

Time taken to complete the request, in milliseconds.

Example:

33