Mock sample for your project: VisibleThread API

Integrate with "VisibleThread API" from visiblethread.com in no time with Mockoon's ready to use mock sample

VisibleThread API

visiblethread.com

Version: 1.0


Use this API in your project

Start working with "VisibleThread API" right away by using this ready-to-use mock sample. API mocking can greatly speed up your application development by removing all the tedious tasks or issues: API key provisioning, account creation, unplanned downtime, etc.
It also helps reduce your dependency on third-party APIs and improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.

Description

Introduction
The VisibleThread b API provides services for analyzing/searching documents and web pages.
To use the service you need an API key.
Contact us at [email protected] to request an API key.
The services are split into Documents and Webscans.
Documents
Upload documents and dictionaries so you can :
Measure the readability of your document
search a document for all terms from a dictionary
retrieve all paragraphs from a document or only matching paragraphs
Webscans
Analyze web pages so you can:
Measure the readability of your web content
Identify & highlight content issues e.g. long sentences, passive voice
The VisibleThread API allows you to programatially submit webpage urls to be scanned,
check on the results of a scan, and view a list of previous scans you have performed.
The VisibleThread API is a HTTP-based JSON API, accessible at https://api.visiblethread.com
Each request to the service requires your API key to be successful.
Getting Started With Webscans
Steps:
Enter your API key above and hit Explore.
Run a new scan by submitting a POST to /webscans (title and some webUrls are required).
The scan runs asynchronously in the background but returns immediately with a JSON response containing an "id" that represents your scan.
Check on the status of a scan by submitting GET /webscans/{scanId}, if the scan is still in progress it will return a HTTP 503. If
it is complete it will return a HTTP 200 with the appropriate JSON outlining the urls scanned and the summary statistics for each url.
Retrieve all your previous scan results by submitting GET /webscans.
Retrieve detailed results for a url within a scan (readability, long sentence and passive language instances) by submitting
GET /webscans/{scanId}/webUrls/{urlId} (scanId and urlId are required)
Getting Started With Document scans:
Steps:
Enter your API key above and hit Explore
Run a new scan by submitting a POST to /documents (document required). The scan runs asynchronously in the background but returns
immediately with a JSON response containins an "id" that represents your scan
Check on the status of a scan by submitting GET /documents/{scanId}, if the scan is still in progress it will return a HTTP 503. If
it is complete it will return a HTTP 200 with the appropriate JSON outlining the document readability results. It will contain detailed
analysis of each paragraph in the document
Retrieve all your previous scan results by submitting GET /documents
Searching a document for keywords
The VisibleThread API allows you to upload a set of keywords or a 'dictionary'. You can then perform a search of a already uploaded document
using that dictionary
Steps (Assuming you have uploaded your document using the steps above):
Upload a csv file to use as a keyword dictionary by submitting a POST to /dictionaries (csv file required). This returns a JSON
response with the dictionary Id
Search a document with the dictionary by submitting a POST to /searches (document id and dictionary id required).
Get the resuhlts of the search by submitting **GET /searches/{docId}/{dictionaryId}" . This will return JSON response containing
detailed results of searching the document using the dictionary.
To view the list of all searches you have performed submit a GET /searches.
Below is a list of the available API endpoints, documentation & a form to try out each operation.

Other APIs in the same category

Generate Barcode images for a given barcode number. You can decode Barcode images and get the barcodes in a numberic form as well. Many industry standard barcode types are supported. The best and complete Barcode API on the cloud. Click here to subscribe
A full featured Facts API. REST access with json/xml/jsonp result support. On this day birth and death support, random fact, keyword search support etc. Below is the documentation for the Random Facts API calls. You can try them out right here. Click here to subscribe

LibreTranslate

libretranslate.local

NLPCloud

nlpcloud.io

PDF Generator API

Introduction
PDF Generator API allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.
The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.
You can find our previous API documentation page with references to Simple and Signature authentication here.
Base URL
The base URL for all the API endpoints is https://us1.pdfgeneratorapi.com/api/v3
For example
https://us1.pdfgeneratorapi.com/api/v3/templates
https://us1.pdfgeneratorapi.com/api/v3/workspaces
https://us1.pdfgeneratorapi.com/api/v3/templates/123123
Editor
PDF Generator API comes with a powerful drag & drop editor that allows to create any kind of document templates, from barcode labels to invoices, quotes and reports. You can find tutorials and videos from our Support Portal.
Component specification
Expression Language documentation
Frequently asked questions and answers
Definitions
Organization
Organization is a group of workspaces owned by your account.
Workspace
Workspace contains templates. Each workspace has access to their own templates and organization default templates.
Master Workspace
Master Workspace is the main/default workspace of your Organization. The Master Workspace identifier is the email you signed up with.
Default Template
Default template is a template that is available for all workspaces by default. You can set the template access type under Page Setup. If template has "Organization" access then your users can use them from the "New" menu in the Editor.
Data Field
Data Field is a placeholder for the specific data in your JSON data set. In this example JSON you can access the buyer name using Data Field {paymentDetails::buyerName}. The separator between depth levels is :: (two colons). When designing the template you don’t have to know every Data Field, our editor automatically extracts all the available fields from your data set and provides an easy way to insert them into the template.
Testing with JWTs
You can create a temporary token in Account Settings page after you login to PDF Generator API. The generated token uses your email address as the subject (sub) value and is valid for 5 minutes.
You can also use jwt.io to generate test tokens for your API calls. These test tokens should never be used in production applications.
Libraries and SDKs
Postman Collection
We have created a Postman Collection so you can easily test all the API endpoints wihtout developing and code. You can download the collection here or just click the button below.
Run in Postman
Client Libraries
All our Client Libraries are auto-generated using OpenAPI Generator which uses the OpenAPI v3 specification to automatically generate a client library in specific programming language.
PHP Client
Java Client
Ruby Client
Python Client
Javascript Client
We have validated the generated libraries, but let us know if you find any anomalies in the client code.
Error codes
| Code | Description |
|--------|--------------------------------|
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 422 | Unprocessable Entity |
| 500 | Internal Server Error |
401 - Unauthorized
| Description |
|-------------------------------------------------------------------------|
| Authentication failed: request expired |
| Authentication failed: workspace missing |
| Authentication failed: key missing |
| Authentication failed: property 'iss' (issuer) missing in JWT |
| Authentication failed: property 'sub' (subject) missing in JWT |
| Authentication failed: property 'exp' (expiration time) missing in JWT |
| Authentication failed: incorrect signature |
403 - Forbidden
| Description |
|-------------------------------------------------------------------------|
| Your account has exceeded the monthly document generation limit. |
| Access not granted: You cannot delete master workspace via API |
| Access not granted: Template is not accessible by this organization |
| Your session has expired, please close and reopen the editor. |
404 Entity not found
| Description |
|-------------------------------------------------------------------------|
| Entity not found |
| Resource not found |
| None of the templates is available for the workspace. |
422 Unprocessable Entity
| Description |
|-------------------------------------------------------------------------|
| Unable to parse JSON, please check formatting |
| Required parameter missing |
| Required parameter missing: template definition not defined |
| Required parameter missing: template not defined |

FunTranslations Braille API

Braille conversion API on the cloud. Translate from English text to Braille and get Braille results suitable for many display types.Click here to subscribe

Taunt as a service

Fungenerators taunt generation API generates random taunts / insults, relevant to the given category. Many categories are supported and new ones are added very frequently. Click here to subscribe

Neutrino API

The general-purpose API

Fake identity generation API

Generate random fake identities (name, address, email, phone , credit card info etc). Click here to subscribe

VisibleThread API

visiblethread.com
Introduction
The VisibleThread b API provides services for analyzing/searching documents and web pages.
To use the service you need an API key.
Contact us at [email protected] to request an API key.
The services are split into Documents and Webscans.
Documents
Upload documents and dictionaries so you can :
Measure the readability of your document
search a document for all terms from a dictionary
retrieve all paragraphs from a document or only matching paragraphs
Webscans
Analyze web pages so you can:
Measure the readability of your web content
Identify & highlight content issues e.g. long sentences, passive voice
The VisibleThread API allows you to programatially submit webpage urls to be scanned,
check on the results of a scan, and view a list of previous scans you have performed.
The VisibleThread API is a HTTP-based JSON API, accessible at https://api.visiblethread.com
Each request to the service requires your API key to be successful.
Getting Started With Webscans
Steps:
Enter your API key above and hit Explore.
Run a new scan by submitting a POST to /webscans (title and some webUrls are required).
The scan runs asynchronously in the background but returns immediately with a JSON response containing an "id" that represents your scan.
Check on the status of a scan by submitting GET /webscans/{scanId}, if the scan is still in progress it will return a HTTP 503. If
it is complete it will return a HTTP 200 with the appropriate JSON outlining the urls scanned and the summary statistics for each url.
Retrieve all your previous scan results by submitting GET /webscans.
Retrieve detailed results for a url within a scan (readability, long sentence and passive language instances) by submitting
GET /webscans/{scanId}/webUrls/{urlId} (scanId and urlId are required)
Getting Started With Document scans:
Steps:
Enter your API key above and hit Explore
Run a new scan by submitting a POST to /documents (document required). The scan runs asynchronously in the background but returns
immediately with a JSON response containins an "id" that represents your scan
Check on the status of a scan by submitting GET /documents/{scanId}, if the scan is still in progress it will return a HTTP 503. If
it is complete it will return a HTTP 200 with the appropriate JSON outlining the document readability results. It will contain detailed
analysis of each paragraph in the document
Retrieve all your previous scan results by submitting GET /documents
Searching a document for keywords
The VisibleThread API allows you to upload a set of keywords or a 'dictionary'. You can then perform a search of a already uploaded document
using that dictionary
Steps (Assuming you have uploaded your document using the steps above):
Upload a csv file to use as a keyword dictionary by submitting a POST to /dictionaries (csv file required). This returns a JSON
response with the dictionary Id
Search a document with the dictionary by submitting a POST to /searches (document id and dictionary id required).
Get the resuhlts of the search by submitting **GET /searches/{docId}/{dictionaryId}" . This will return JSON response containing
detailed results of searching the document using the dictionary.
To view the list of all searches you have performed submit a GET /searches.
Below is a list of the available API endpoints, documentation & a form to try out each operation.

PDF Blocks API

PDF Blocks is a secure, reliable, and fast API to work with PDF documents. Actions include: Merge PDF documents, add or remove passwords, add watermarks, remove, extract, reverse, and rotate pages, and more.

Geneea Natural Language Processing

geneea.com
Authentication
For all calls, supply your API key. Sign up to obtain the key .
Our API supports both unencrypted (HTTP) and encrypted (HTTPS) protocols.
However, for security reasons, we strongly encourage using only the encrypted version.
The API key should be supplied as either a request parameter user_key or in Authorization header.
Authorization: user_key
API operations
All API operations can perform analysis on supplied raw text or on text extracted from a given URL.
Optionally, one can supply additional information which can make the result more precise. An example
of such information would be the language of text or a particular text extractor for URL resources.
The supported types of analyses are:
lemmatization ⟶
Finds out lemmata (basic forms) of all the words in the document.
correction ⟶
Performs correction (diacritization) on all the words in the document.
topic detection ⟶
Determines a topic of the document, e.g. finance or sports.
sentiment analysis ⟶
Determines a sentiment of the document, i.e. how positive or negative the document is.
named entity recognition ⟶
Finds named entities (like person, location, date etc.) mentioned the the document.
Encoding
The supplied text is expected to be in UTF-8 encoding, this is especially important for non-english texts.
Returned values
The API calls always return objects in serialized JSON format in UTF-8 encoding.
If any error occurs, the HTTP response code will be in the range 4xx (client-side error) or
5xx (server-side error). In this situation, the body of the response will contain information
about the error in JSON format, with exception and message values.
URL limitations
All the requests are semantically GET. However, for longer texts, you may run into issues
with URL length limit. Therefore, it's possible to always issue a POST request with all
the parameters encoded as a JSON in the request body.
Example:
POST /s1/sentiment
Content-Type: application/json
{"text":"There is no harm in being sometimes wrong - especially if one is promptly found out."}
This is equivalent to GET /s1/sentiment?text=There%20is%20no%20harm...
Request limitations
The API has other limitations concerning the size of the HTTP requests. The maximum allowed size of any
POST request body is 512 KiB. For request with a URL resource, the maximum allowed number of
extracted characters from each such resource is 100,000.
Terms of Service
By using the API, you agree to our
Terms of Service Agreement.
More information
The Interpretor Public Documentation