Endpoints Overview Part 1: AI, Business, Code, Image & PDF

Part 1 of our three-part series: Discover our API endpoints in AI, Business, Code, Image, and PDF. Learn what they do, how they work, and their benefits.

Published
June 13, 2024

In this three-part series, we will examine several API endpoints in our ecosystem and demonstrate what they do, how they function and the value that they provide. This first section covers five key categories: AI, Business, Code, Image, and PDF. Every category holds unique endpoints suitable for the completion of different tasks – from text recognition or content recognition to email validation and code execution.

AI

The AI category involves many endpoints intended to use sophisticated algorithms and machine learning methods. The number of credits for each execution of the AI endpoints is 10. These endpoints include:

Picture Text Recognition

Picture Text Recognition is an API capable of performing text recognition from images. When an image’s link is passed through the API, the image undergoes OCR and the text that is within the image is extracted.

Detect Adult Content

The Adult Content Detector is an API utilized for the evaluation of obscene, sexually suggestive, or violent content. When a person submits the image’s URL, the API analyzes the image and returns the analysis together with confidence scores for each of the categories of inappropriate contents.

Entity Detection

The Entity Detection endpoint is an API, with which it is possible to detect the key entities in a text and sort them by dates, locations, and so on. It also recognizes these entities, their categories, positions in the text, and their confidence level. If you would like to see a use case with this endpoint, we recommend you read this blog.

Business

Business category belongs to the endpoints that are needed for business processes and data credibility. All the endpoints cost 1 credit per run. These endpoints include:

Validate Email

The Email Validator API helps in the validation of email addresses, and the correction of mistakes that might be contained in the addresses. Thus, the email address is sent to the API, the API then checks it for correctness and offers possible corrections to ensure proper channels of communication and quality of data.  

Validate VAT

European businesses could benefit from this VAT Validation API to check the authenticity of a VAT numbers to avoid mistakes while conducting operations. This is done either by inputting the Full VAT ID number or Country Code and the actual VAT number. The API validates the input and returns the status of the VAT number.

Validate Geolocation

The Validate Geolocation endpoint is an API that checks the correctness of addresses given. When an address is provided, the API verifies if the address exists and is correct, and it may also provide validation information as well as geolocation information such as latitude or longitude. Important: This is the only Business endpoint where every call made to the endpoint costs 5 credits.

Code

The Code category provides endpoints for running and managing code snippets in various programming languages. Every time you run any of the Code endpoints you will be charged 2 credits.

Run JS Code

The JavaScript Code Executor enables you to execute JavaScript code in a remote environment. The users submit their JavaScript code on a request and the API runs that code and returns the results immediately.

Asynchronous Python  

Asynchronous Python Code Executor will enable you to execute Python code snippets on a remote platform without having to wait for the operation to be completed before proceeding to other operations. This allows the users to upload their code and any dependencies that may be needed, and the API to run the code on our server and report the results to a provided webhook URL.

Run Python Code

The Python Code Executor enables users to submit Python code snippets and get results back from a remote platform in a short time. Users submit their Python code via an API request, and it executes the code on our servers and sends back the result in a structured format. Here's a YouTube video with an example of an automation where our Python Code Executor was involved.

Image

The Image category allows you to work with methods for image processing and manipulation. Every call of the Image endpoints consumes 5 credits. These endpoints include:

Exif

The Get Exif is an endpoint that offers users the chance to get a comprehensive set of data related to EXIF (Exchangeable Image File Format). The API then extracts useful characteristics about a picture that can include camera and software details from the submitted image's URL.

Crop

The Image Crop API lets you crop an image by defining coordinates and size of the crop area. Users submit the image URL and the cropping details, and the API handles the image and sends back a path to the cropped image.

Blur

The Blur Image endpoint enables the user to blur specified areas on the image to obscure the depicted information and avoid identification of specific individuals or objects. Using the URL of an image and the sigma value with the desired amount of blur, the endpoint processes the image and returns a URL of the blurred image.

PDF

The PDF category provides an impressive list of endpoints that can be used to perform different actions on PDF files. The execution of all the PDF endpoints costs 5 credits each. These endpoints include:

Merge

The PDF Merger endpoint takes PDF files and compiles them into one. Users provide the PDF files for merging, which may be through the URL or taken directly from the buffers. The API takes these inputs and combines the files into one document. Importantly, the users can optionally name the merged file.

HTML to PDF

The HTML to PDF Converter endpoint converts HTML content to PDF format. It's also possible to write the HTML directly or provide an URL where the HTML is situated, and the endpoint analyzes and returns the content in a PDF file. The options are to receive the PDF as a downloadable link or as a buffer.

OCR

The PDF OCR endpoint detects text within PDF files using the OCR technology. Users supply the URL of the PDF file, and the system determines the textual components on the PDF pages.

What’s a Rich Text element?

The rich text element allows you to create and format headings, paragraphs, blockquotes, images, and video all in one place instead of having to add and format them individually. Just double-click and easily create content.

Static and dynamic content editing

A rich text element can be used with static or dynamic content. For static content, just drop it into any page and begin editing. For dynamic content, add a rich text field to any collection and then connect a rich text element to that field in the settings panel. Voila!

How to customize formatting for each rich text

Headings, paragraphs, blockquotes, figures, images, and figure captions can all be styled after a class is added to the rich text element using the "When inside of" nested selector system.