Getting Started
How to begin
The first step to using the Intelligent API is to sign up for an account if you haven't already. This can be done by visiting https://dash.intelligent-api.com/login and entering your email address.
You will receive 200 free credits to use to test the API when you sign up.
Create credentials to use with the API
Before you begin using the Intelligent API, you must create at least one set of credentials to use with the API.
API credentials can be managed from the OAuth API Access or Basic API Access section of the dashboard. You can use either of the following types of credentials:
OAuth Credentials
Using this method you pass your credentials to a token generation endpoint and receive a short-liven token that expires after 4 hours. You then use this token by passing it as a standard Bearer Authorization header when calling the API to authenticate the caller. This method means you must store the token somewhere and regenerate a new one before it expires (every 4 hours).
Basic Credentials
Using this method you base64 encode and then pass your credentials in an Basic Authorization header to the API and the caller is authenticated using those credentials.
Use the playground to test the endpoints
The playground allows you to see the API endpoints in action. You can invoke each of the endpoints using your own documents / data and see the responses as well as sample code on how to call the specific endpoint.
The playground options available:
| Playground | Usage |
|---|---|
| Document OCR | Optical character recognition (or conversion from image or document to text) of receipts, invoices, identity documents and documents. Also allows for summarization of the text of an image or document. |
| Language | Detect the language used in text, or translate text between languages. |
| Media | Transcribe an audio file, classify text, work out todos with reminders, return the list of items from an image or get the calorie counts and macros from images and text. |
| PII | Detect or redact any Personally Identifiable Information (PII) from text. |
| Text | Determine the sentiment of or summarize text. |
| Web Scraper | Extract the contents of a webpage in markdown or generate an immediate summary of the page. |
Build your integration
Using the programming language of your choice, integrate with the API.
Once you have setup your credentials and you know what endpoints you want to use, you can begin to integrate your app, API or relevant project. There are sample integrations showing how to use the endpoints for some common use cases in the Code Examples Github repository, so be sure to check that out if you need some ideas or sample code to get going.
Subscribe or top-up your account
Keep your credits topped up to avoid your API access being restricted.
You can choose to Subscribe and have an automated monthly top-up of your credits, or you can choose to manually Top-Up as and when you need. You can also do combinations of subscriptions and top-ups as you see fit. Subscriptions are managed via a Billing Portal provided by our payment provider which you will gain access to using your email address after your first payment has been completed.
Our payment provider caters for any tax requirements you may have and tax information can be supplied during the payment process should you need to. You will also be issued a tax invoice to your email address.
Help is available
Use the documentation, postman collection or code examples to assist you build your integration.
To assist you on your way, we have comprehensive API Reference, a Bruno Collection, a Postman Collection and Code Examples you can use. If at any point you need assistance, please feel free to reach out to our helpful support team via email at [email protected]. We also welcome any feedback, suggestions or critique via email at [email protected].