PARSER GUIDES

Create Classifier

POST

/api/v1/classifiers

Create a document classifier with at least one routing rule. Classifiers route documents to parsers and do not define extraction fields.

Authorization

bearerAuth

authorization: <token>

Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')

In: header

Request Body

application/json

name — string

description?string

acceptedFileTypes?array<string\>

routing — object

splitDocuments?SplitDocumentsSettings

PDF split settings for a parser. Split settings apply to PDF files imported through uploads, email, upload pages, embeds, API, URL imports, and Zapier.

isActive?boolean

\[key: string\]?never

Response Body

201

application/json

400

application/json

curl -X POST "https://api.PARSER.com/api/v1/classifiers" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "routing": {      "rules": [        {          "label": "Invoice",          "targetParserId": "c1414b5c-cc7f-4042-9bc2-fa9363157ee6"        }      ],      "fallback": {        "action": "skip"      }    }  }'

201400

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Claims intake",
  "description": "string",
  "isActive": true,
  "emailAddress": "contact@parser.example",
  "acceptedFileTypes": [
    {
      "mimeType": "application/pdf",
      "label": "PDF"
    }
  ],
  "settings": {
    "routing": {
      "rules": [
        {
          "id": "string",
          "label": "Invoice",
          "targetParserId": "c1414b5c-cc7f-4042-9bc2-fa9363157ee6"
        }
      ],
      "fallback": {
        "action": "skip",
        "targetParserId": "c1414b5c-cc7f-4042-9bc2-fa9363157ee6"
      },
      "instructions": "string"
    },
    "splitDocuments": {
      "enabled": true,
      "mode": "everyXPages",
      "everyXPages": 5,
      "pageRanges": "1, 3, 7-9",
      "instructions": "Each invoice starts with an invoice number at the top.",
      "partitionKey": "transactions.transaction_date",
      "partitionKeySource": "parserField"
    }
  },
  "counts": {
    "totalDocuments": 0,
    "routed": 0,
    "skipped": 0,
    "failed": 0
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{
  "error": true,
  "message": "Parser ID mismatch"
}