Introduction
ParserBee API allows you to extract structured data from documents (PDFs, images, Word, PowerPoint, Excel, and more) using custom templates.
Getting Started
1. Create an Account
Sign up at app.parserbee.com and verify your email address.
2. Generate an API Key
- Log in to your dashboard
- Go to Settings from the sidebar
- Click Generate API Key
- Copy and securely store your API key (it starts with
pk_)
Important: You can view your API key anytime from Settings. If you need to regenerate it, click Regenerate API Key, but note that the old key will be invalidated.
3. Make Your First API Call
Use your API key in the x-api-key header with every request:
curl -X POST https://app.parserbee.com/api/v1/extract \
-H "x-api-key: pk_your_api_key_here" \
-F "template_id=your_template_id" \
-F "[email protected]"Authentication
All API endpoints require authentication via the x-api-key header. You can generate and manage your API key from the Settings page in your dashboard.
Rate Limits & Credits
Each document extraction costs 1 credit. Your credit balance depends on your subscription plan. You can check your remaining credits via the /api/v1/credits endpoint or from the dashboard.
Supported File Types
Documents
- PDF (
application/pdf) - Word (
.docx,.doc) - PowerPoint (
.pptx,.ppt) - Excel (
.xlsx) - OpenDocument Text (
.odt) - Rich Text (
.rtf) - Plain text (
.txt) - CSV (
.csv) - HTML (
.html,.htm) - Email (
.eml)
Images
- PNG (
image/png) - JPEG (
image/jpeg,image/jpg) - WebP (
image/webp) - HEIC/HEIF (
image/heic,image/heif)
Not supported: legacy Excel (.xls), OpenDocument Spreadsheet (.ods), and OpenDocument Presentation (.odp).
Maximum file size: 50 MB