PARSER GUIDES

Get Parser

GET

/api/v1/parsers/{parserId}

Retrieve one active document parser by ID. Classifier IDs return a parser-only error; use the classifier APIs for classifiers.

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

Path Parameters

parserId — string

The ID of the parser

Format: uuid

Response Body

200

application/json

401

application/json

404

application/json

curl -X GET "https://api.PARSER.com/api/v1/parsers/d1458cd7-8692-488f-8b3f-0fddade05f9c"

200401404

{
  "id": "d1458cd7-8692-488f-8b3f-0fddade05f9c",
  "name": "Invoice Parser",
  "description": "Extracts purchase order and invoice fields.",
  "type": "document",
  "isActive": true,
  "acceptedFileTypes": [
    {
      "mimeType": "application/pdf",
      "label": "PDF"
    }
  ],
  "settings": {
    "acceptedFileTypes": [
      {
        "mimeType": "application/pdf",
        "label": "PDF"
      }
    ],
    "confidenceScores": {
      "enabled": true
    },
    "markdownParsing": {
      "enabled": true
    },
    "advancedTableExtraction": "disabled",
    "dataExtractionMode": "fast",
    "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"
    },
    "classificationGate": {
      "enabled": true,
      "mode": "allow",
      "labels": [
        "Invoice",
        "Purchase Order"
      ],
      "instructions": "Only accept vendor invoices, not support tickets.",
      "costPerDocument": 0.1
    },
    "emailParsing": {
      "parseEmailBody": true,
      "mergeEmailAttachments": true,
      "includeEmailSubjectBody": true,
      "attachmentFileTypes": [
        "string"
      ],
      "senderFilter": {
        "mode": "disabled",
        "rules": [
          {
            "type": "email",
            "value": "contact@parser.example"
          },
          {
            "type": "domain",
            "value": "example.com"
          }
        ]
      }
    },
    "parsePages": "string"
  },
  "createdAt": "2026-01-23T18:11:47.319Z",
  "updatedAt": "2026-01-23T18:12:29.860Z",
  "counts": {
    "totalDocuments": 128,
    "folders": 4
  }
}

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

{
  "error": true,
  "message": "Document not found",
  "notFound": [
    {
      "type": "documentId",
      "value": "string"
    }
  ]
}