API reference
Endpoints, request fields, responses and errors for the SimplyParse REST API.
The SimplyParse API is a small REST API: send documents to your parsers, fetch results, correct values and export data. Each endpoint page has a playground to send real requests with your token.
Basics
| Base URL | https://api.simplyparse.com |
| Authentication | Authorization: Token YOUR_API_TOKEN (details) |
| Request bodies | multipart/form-data for parsing, JSON for corrections |
| Responses | JSON envelope: status, code, message, data (details) |
| Errors | Check status as well as the HTTP code (details) |
Endpoints
Parsing
POST
/dapi/v1/parser/{slug}/parseParse a document and get the data in the response.
POST
/dapi/v1/parser/{slug}/parse/asyncQueue a document and get a document_id back immediately.
Documents
GET
/dapi/v1/parser/{slug}/document/{document_id}Check a document's status and fetch its entries.
Parsed data
PUT
/dapi/v1/parser/{slug}/parsed-data/{entry_id}Correct top-level values on an entry.
GET
/dapi/v1/parser/{parser_id}/export/Download a parser's data as an Excel workbook.
Webhooks
POST
https://your-server.example.com/…Sent by SimplyParse to your endpoint when a document has been processed.
Path parameters
| Parameter | Where to find it |
|---|---|
slug | The parser's Integrations tab, in its endpoint URL. Must be your own parser, not a library template. |
parser_id | The dashboard URL: app.simplyparse.com/parsers/<parser_id>. |
document_id | Returned by the async parse endpoint and included in webhooks. |
entry_id | entries[].id from Get a document, entry_id in webhooks, or data[].document_id in the sync response. |
Machine-readable spec
The OpenAPI 3.1 description that powers these pages is at /openapi.yaml. Import it into Postman or Insomnia, or generate a typed client:
npx @openapitools/openapi-generator-cli generate -i https://<docs-host>/openapi.yaml -g python -o simplyparse-client