Documentation for the docTeller API
The docTeller API is very simple to use. All you need to start parsing documents is to create an account on docteller.com & implement a POST request to a single endpoint!
Here, you will learn through a few examples how to send pictures of documents to our API, and retrieve a JSON containing all the data extracted by our AI.
Getting Started
1. Account & API Key 🔑
- a. To get an API Key, you need to create an account at docteller.com.
- b. Confirm your email, then sign in to your account, and you will be able to manage your API Keys on the main screen.
A default API Key has already been created for you at registration, you can use that one or delete it and create as many API Keys as you want (we recommend one for each of your environments).
2. Parsing your first document 📜
ℹ️ Don't have a document on hand to try the API? That's okay, here are 2 sample documents we will be using as examples in this section:
To parse your first document, you just have to copy-paste the following code and replace the values of the path to the document, and the API Key.
If you are in a hurry, you can stop reading here and start using the above code.
In the next two subsections, we will show 2 examples of documents and the corresponding JSON outputs from our API:
Supported documents
For the full list of supported documents and the fields you can extract from them, check out out dedicated page here.
We support all common image types, and also PDF files.
There can be multiple documents in a single image or PDF page. There can be multiple pages in a PDF.
No need to crop the images or fix the orientation. Just send us your document and we handle everything.
Our algorithm manages to parse pictures of documents even when they were taken in imperfect conditions, within reasonable limits:
- Dim lighting? No problem!
- Blurry picture? No problem!
- Flash & reflections? No problem!
- Perspective? No problem!
- Random orientation? No problem!
Supported file extensions include:
- JPG, JPEG, PNG, TIFF...
- and practically all other image formats. Try it for yourself or send us a feature request if you want us to support your file format!
Quota
You can parse 150 documents per month for free, whatever your subscription plan.
Quotas reset on the 1st of every month at 00:00 UTC.
What counts towards your quota is the number of documents detected.
- If you send a request with a picture containing 1 document, your quota will increase by 1
- If you send a request with a picture containing 3 documents, your quota will increase by 3
- If you send a request with a PDF containing 2 pages, with 2 documents on the first page and 3 documents on the second page, your quota will increase by 5
For users on the Free plan, once the quota limit of 150 documents is reached, the API will return errors with status code 429. If you need a temporary increase in your quota, shoot us an email and we may arrange this for you.
For users on our paid plans, the usage is unlimited.
Custom use cases
Do you have a more complex use case?
Special types of documents you would like us to support?
We offer paid professional services for your custom needs:
☞ Contact us at [email protected]!
Data & Privacy
We do not store any of the documents you send to our servers.
docTeller is a French company, and our servers are located within the European Union. We are GDPR compliant.