Documentation
API reference
Turn any PDF into typed JSON with a single REST call. Authenticate with your API key, post a document, and receive fields, tables, and relations with per-field confidence.
Authentication
All requests are authenticated with an API key sent as a Bearer token in the Authorization header. Keep your key secret; never expose it in client-side code.
Header
Authorization: Bearer YOUR_API_KEY
Extract a document
Send a document as multipart/form-data to POST /v1/extract. The request returns typed JSON with the extracted data.
Parameters
- filerequired
- The document to extract, e.g. an invoice PDF.
- schema_typerequired
- The document schema to apply, e.g. invoice.
Request
# Turn an invoice PDF into typed JSON curl -X POST https://api.parsift.com/v1/extract \ -H "Authorization: Bearer YOUR_API_KEY" \ -F "[email protected]" \ -F "schema_type=invoice"
Response
A successful call returns 200 OK with a status of success and a data object holding the extracted fields.
Response · 200 OK
{
"status": "success",
"data": {
"vendor": "AWS Inc.",
"total": 4500.00
}
}Supported formats
PDF and images (PNG, JPG, TIFF). The format is detected automatically.
Self-serve API keys are coming soon.
Join the waitlist to get yours when account creation opens, or talk to our team about your use case.