REST API
Programmatic access to parsers, documents, results, and webhook subscriptions.
The Parsedit REST API (v1) lets you create documents, read extraction results, and subscribe to events from your own software.
Authentication
Every request needs a Bearer token in the Authorization header:
Authorization: Bearer <access_token>
Tokens are issued when you authorize a connected application through Parsedit's OAuth flow, and each token carries scopes that limit what it can do (for example documents:read or webhooks:write). You can revoke a connected application, and all of its tokens, under Integrations → Connected applications. Requests without a valid token get 401; tokens missing the required scope get 403.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/me | Authenticated account and token metadata |
| GET | /api/v1/parsers | List parsers (cursor pagination) |
| GET | /api/v1/parsers/:id | Get a single parser |
| GET | /api/v1/documents | List documents, filterable by parser_id, status, and include_extracted |
| POST | /api/v1/documents | Create a document via multipart upload, base64, or URL |
| GET | /api/v1/documents/:id | Get a single document |
| GET | /api/v1/documents/:id/result | Get the extracted result payload |
| POST | /api/v1/webhooks | Subscribe to document events |
| DELETE | /api/v1/webhooks/:id | Delete a webhook subscription |
List endpoints use cursor-based pagination. Read and write endpoints are rate limited separately.
Creating documents
POST /api/v1/documents accepts the file three ways: a multipart form upload, a base64-encoded body, or a URL that Parsedit fetches. The document is processed by the parser you specify, subject to the same format and size limits and duplicate detection as every other intake channel.
Webhook subscriptions
Subscriptions created via POST /api/v1/webhooks deliver signed event payloads to your endpoint. Each delivery is a JSON POST with two verification headers:
X-Parsedit-Signature: an HMAC SHA-256 hex digest of the request body, computed with your subscription's signing secret.X-Parsedit-Event: the event name.
Recompute the HMAC over the raw body and compare it to the signature header to verify authenticity. These API subscriptions are separate from the per-parser webhook destination, which delivers extracted data with your own custom headers.