Parsers API Reference
Manage extraction templates programmatically. Create, list, update, and delete parsers — and auto-detect schema fields from a sample document — with the PerfectParser Parsers API.
A Parser is a reusable extraction template. It defines which fields to pull from your documents and how results are structured. Every extraction job references a parser by ID.
Typical setup flow
- Create a parser — create an empty parser container (or include initial field definitions).
- Detect fields — upload a sample document and auto-generate a schema in one step (multipart).
- Update the parser — refine field names, types, or descriptions as needed.
After setup, use the parser ID when submitting documents via Extractions.
Endpoints
| Endpoint | Description |
|---|---|
| Create Parser | POST /v1/parsers |
| List Parsers | GET /v1/parsers |
| Get Parser | GET /v1/parsers/:parser_id |
| Update Parser | PATCH /v1/parsers/:parser_id |
| Delete Parser | DELETE /v1/parsers/:parser_id |
| Detect Fields | POST /v1/parsers/:parser_id/detect-fields |
Related
- Quickstart — end-to-end example that creates a parser and runs an extraction.
- Webhooks — real-time delivery instead of polling.
- Zapier integration — no-code export and import.
- Extractions — submit documents against a configured parser.