
Security News
Official Go SDK for MCP in Development, Stable Release Expected in August
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.
Site | NPM Module | GitHub Repo
optiic is the official npm module of Optiic, a free image recognition & optical character recognition (OCR) API. It works on any image as well as PDFs!
Yes, this module works in both Node and browser environments, including compatibility with Webpack and Browserify!
.pdf
, .png
, .jpeg
, and many more!You can use so much of optiic
for free, but if you want to do some advanced stuff, you'll need an API key. You can get one by signing up for an account.
Install with npm if you plan to use optiic
in a Node project or in the browser.
npm install optiic
If you plan to use optiic
in a browser environment, you will probably need to use Webpack, Browserify, or a similar service to compile it.
const optiic = new (require('optiic'))({
apiKey: 'api_test_key' // Not required, but having one removes limits (get your key at https://optiic.dev).
});
Install with CDN if you plan to use Optiic only in a browser environment.
<script src="https://cdn.jsdelivr.net/npm/optiic@latest/dist/index.min.js"></script>
<script type="text/javascript">
let optiic = new Optiic({
apiKey: 'api_test_Key' // Not required, but having one removes limits (get your key at https://optiic.dev).
});
</script>
You can use optiic
in a variety of ways that require no installation, such as curl
in terminal/shell. See the Use without installation section below.
If you want to see how optiic
works, you can try a sample such as this image:
This will result in an output like this:
{
text: "We love Optiic!",
language: "en",
}
After you have followed the install step, you can start using optiic
to analyze images and perform OCR from within your app!
Submit and image to process and return the text in the image.
The options for process(options)
are as follows.
string
, HTML Input Element
, File
: The image to be processed. Can be a local path, remote URL, an HTML input, or a File object.
any
null
string
: What type of optical recognition will be run, such as OCR.
ocr
ocr
let options = {
image: 'https://optiic.dev/assets/images/samples/we-love-optiic.png', // url of the image
mode: 'ocr', // ocr
};
optiic.process(options)
.then(result => {
console.log(result);
})
let options = {
image: '/Users/username/Desktop/my-image.png', // local path to the image
mode: 'ocr', // ocr
};
optiic.process(options)
.then(result => {
console.log(result);
})
<form class="" action="" method="post">
<input type="file" name="image" accept="image/*">
<button type="submit">Submit</button>
</form>
<script type="text/javascript">
var myForm = document.querySelector('form');
myForm.addEventListener('submit', function (event) {
event.preventDefault();
optiic.process({
image: myForm.querySelector('input[type="file"]'),
})
.then(response => {
console.log(response);
})
})
</script>
curl
curl \
-d '{"apiKey": "test_api_key", "url": "https://optiic.dev/assets/images/samples/we-love-optiic.png"}' \
-H 'Content-Type: application/json' \
https://api.optiic.dev/process
curl \
-F "apiKey=test_api_key" \
-F "image=@/Users/username/Desktop/my-image.png" \
https://api.optiic.dev/process
Optiic is a free OCR api that helps you analyze images and perform OCR (optical character recognition)!
For a more in-depth documentation of this library and the Optiic service, please visit the official Optiic website.
If you are still having difficulty, we would love for you to post a question to the Optiic issues page. It is much easier to answer questions that include your code and relevant files! So if you can provide them, we'd be extremely grateful (and more likely to help you find the answer!)
Somiibo: A Social Media Bot with an open-source module library.
JekyllUp: A website devoted to sharing the best Jekyll themes.
Slapform: A backend processor for your HTML forms on static sites.
SoundGrail Music App: A resource for producers, musicians, and DJs.
Hammock Report: An API for exploring and listing backyard products.
Ask us to have your project listed! :)
FAQs
An advanced free OCR & image recognition API.
The npm package optiic receives a total of 16 weekly downloads. As such, optiic popularity was classified as not popular.
We found that optiic demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.
Security News
New research reveals that LLMs often fake understanding, passing benchmarks but failing to apply concepts or stay internally consistent.
Security News
Django has updated its security policies to reject AI-generated vulnerability reports that include fabricated or unverifiable content.