Skip to content
OpenParablePublic APIs

VisibleThread API API

by visiblethread.com

API keyHTTPSText Analysis
Open documentation ↗

Overview

## 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: 1. Enter your API key above and hit **Explore**. 2. 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. 3. 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. 4. Retrieve all your previous scan results by submitting **GET /webscans**. 5. 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: 1. Enter your API key above and hit **Explore** 2. 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 3. 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 4. 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): 1. 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 2. Search a document with the dictionary by submitting a **POST to /searches** (document id and dictionary id required). 3. 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. 4. 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.

VisibleThread API is a text analysis API from visiblethread.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 12 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Category
Text Analysis
Base URL
https://api.visiblethread.com/api/v1
Version
1.0
Endpoints
12
OpenAPI
Specification ↗
Spec updated
2021-06-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.visiblethread.com/api/v1/dictionaries" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://api.visiblethread.com/api/v1/dictionaries", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.visiblethread.com/api/v1/dictionaries",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/dictionariesGet your list of dictionaries
POST/dictionariesUpload a dictionary (CSV)
GET/documentsGet your list of documents
POST/documentsUpload a document
GET/documents/{docId}Get data from a previously submitted document
GET/searchesGet your list of searches
POST/searchesRun a search
GET/searches/{docId}/{dictionaryId}Gets search results for a particular document/dictionary
GET/webscansGet your list of scans
POST/webscansRun a new scan
GET/webscans/{scanId}Get data from a previously run scan
GET/webscans/{scanId}/webUrls/{urlId}Gets data for a particular scan/webUrl

Questions

Does the VisibleThread API API need an API key?

Yes. The VisibleThread API API uses API key authentication; the documentation explains how to get credentials.

Does the VisibleThread API API support HTTPS?

Yes, the VisibleThread API API is served over HTTPS.

How many endpoints does the VisibleThread API API have?

Its OpenAPI description lists 12 endpoints in version 1.0. All of them are shown on this page.

What are alternatives to the VisibleThread API API?

Other Text Analysis APIs include Google Cloud Natural, LanguageTool, Tisane, LibreTranslate, Asynchronous Speech-To-Text API Documentation.

Compare alternatives →

Google Cloud Natural

Text Analysis

Natural language understanding technology, including sentiment, entity and syntax analysis

API key

LanguageTool

Text Analysis

Style and Grammar Checker for 25+ Languages

No auth5 endpoints

Tisane

Text Analysis

Text Analytics with focus on detection of abusive content and law enforcement applications

OAuthCORS6 endpoints

LibreTranslate

Text Analysis

Translation tool with 17 available languages

No auth

Asynchronous Speech-To-Text API Documentation

Text Analysis

Rev.ai provides quality speech-text recognition via a RESTful API. All public methods and objects are documented here for developer reference. For a real-time speech to text solution, use Rev.ai's [Streaming API](/docs/streaming). # Base Endpoint The base url for this version of the API is > `https://api.rev.ai/speechtotext/v1` All endpoints described in this documentation are relative to this base url. # Quick Start Follow the [getting started checklist](https://www.rev.ai/getting_started) ## Get your Access Token You can generate your [access token](#section/Authentication/Access-Token) on the [settings page](https://www.rev.ai/access_token) of your account. This access token only needs to be generated once and never expires. You can re-generate your token, however this will invalidate the previous token. ## Submit a File To submit an audio file for transcription to Rev.ai: ``` curl -X POST "https://api.rev.ai/speechtotext/v1/jobs" -H "Authorization: Bearer $REV_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{\"media_url\":\"https://www.rev.ai/FTC_Sample_1.mp3\",\"metadata\":\"This is a sample submit jobs option\"}" ``` You’ll receive a response like this: ~~~ { "id": "Umx5c6F7pH7r", "created_on": "2018-09-15T05:14:38.13", "name": "sample.mp3", "metadata": "This is a sample submit jobs option for multipart", "status": "in_progress" } ~~~ The `id` (in this case `Umx5c6F7pH7r`) will allow you to retrieve your transcript. ## Get Your Transcript Once a transcription job's `status` becomes `transcribed`, you can retrieve the transcript in JSON format by running: ``` curl -X GET "https://api.rev.ai/speechtotext/v1/jobs/{id}/transcript" -H "Authorization: Bearer $REV_ACCESS_TOKEN" -H "Accept: application/vnd.rev.transcript.v1.0+json" ``` Alternatively you can get the plain text version by running: ``` curl -X GET "https://api.rev.ai/speechtotext/v1/jobs/{id}/transcript" -H "Authorization: Bearer $REV_ACCESS_TOKEN" -H "Accept: text/plain" ``` You can poll for the `status` of your job by querying for the job periodically: ``` curl -X GET https://api.rev.ai/speechtotext/v1/jobs/{id} -H "Authorization: Bearer $REV_ACCESS_TOKEN" ``` **Note:** Polling is NOT recommended in a production server. Rather, use [webhooks](#section/Webhooks) to asynchronously receive notifications once the transcription job completes If you have any further questions, contact us at <[email protected]> # Submitting Files Two `POST` request formats can be used to submit a file: `application/json` or `multipart/form-data`. ## JSON This is the preferred method of file submission. Uses the `media_url` property to provide a direct download URL to the Rev.ai server. This method supports the use of pre-signed URLs. Links to videos hosted on platforms like Youtube are not valid because they are not direct download links. **Important note on presigned URLs:** Signed URLs usually have an expiration time which is configurable. To ensure the Rev.ai server can access the link, make sure the expiration time is set to 2 hours or more. In the event you plan on resending the same file, make sure to generate a new presigned URL. ## FormData Used to send a local file to the Rev.ai server. This allows the customer to send the file directly from the host machine. Certain limits apply to this format, see the [Async API Limits section](#section/Async-API-Limits) for more detals. # Turnaround Time and Chunking Often, especially for shorter files, your transcript will be ready in 5 minutes or less. It generally takes no longer than 15 minutes to return longer audios. If you require faster turn around time please contact <[email protected]> Chunking is the act of breaking audio files into smaller segments. Rev.ai uses this method to decrease turnaround time of audios greater than 3 minutes in length. # Webhooks If the optional `callback_url` is provided, the API will make an HTTP POST request to the `callback_url` with the following request body when the job either completes successfull

Bearer token7 endpoints

Detect Language

Text Analysis

Detects text language

API key

Listed from APIs.guru (CC0).