This repository is a Python 3+ reference client implementation for the Sypht API at https://api.sypht.com.
For example, you can upload an image or pdf of a bill or invoice and extract the amount due, due date, invoice number and biller information.
For an up-to-date list of supported extraction types, see the Marketplace.
To get started you'll need API credentials, i.e. a
<client_secret>, which can be obtained by registering for an account
Latest version is available via pypi:
pip install sypht
from sypht.client import SyphtClient sc = SyphtClient('<client_id>', '<client_secret>') with open('invoice.png', 'rb') as f: fid = sc.upload(f, products=["forms-&-reports"]) print(sc.fetch_results(fid))
or run it via the command line:
export SYPHT_API_KEY="<client_id>:<client_secret>" sypht extract --product invoices path/to/your/document.pdf
Visit the Marketplace to see the full set of available AI Products, document types and data fields supported.
Advanced workflows, features and field data structures are covered in the Dev Guide.
The software in this repository is available as open source under the terms of the MIT License.
Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.