VisibleThread API
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…
AI & machine learning#openapi#text
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
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 support@visiblethread.com 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.
Endpoints 12
Documents
- GETGet your list of dictionaries
/dictionariesGet your list of dictionaries - POSTUpload a dictionary (CSV)
/dictionariesUpload a dictionary (CSV format) to your VisibleThread account. - GETGet your list of documents
/documentsGet your list of documents - POSTUpload a document
/documentsUpload a document to your VisibleThread account. We return a JSON response that contains a "docId" that represents your document. You can use this id in other… - GETGet data from a previously submitted document
/documents/:docIdGet data from a previously submitted document identified by *docId* - GETGet your list of searches
/searchesGet your list of searches - POSTRun a search
/searchesRun a search on document docId using dictionary dictId - GETGets search results for a particular document/dictionary
/searches/:docId/:dictionaryId?matchingOnly=trueGet detailed results for a scan/url (readability, long sentence and passive language instances), identified by scanId & urlId
Webscans
- GETGet your list of scans
/webscansGet your list of scans - POSTRun a new scan
/webscansThe scan runs in the background but returns immediately with a JSON response containing an "id" that represents your scan. You can use this id in other… - GETGet data from a previously run scan
/webscans/:scanIdGet data from a previously run scan, identified by scanId - GETGets data for a particular scan/webUrl
/webscans/:scanId/webUrls/:urlIdGet detailed results for a scan/url (readability, long sentence and passive language instances), identified by scanId & urlId
API details
- Base URL
https://api.visiblethread.com/api/v1- Authentication
- An API key in the apiKey header
- Operations
- 12 operations on 8 pathsGET 8POST 4
- Main resources
- Documents 8Webscans 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the VisibleThread API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the VisibleThread API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apiKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get your list of dictionaries” (GET /dictionaries), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the VisibleThread API?
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… It is listed under AI & machine learning and has 12 endpoints.
Who publishes the VisibleThread API?
It is listed from VisibleThread's public API description (an OpenAPI document), not published by VisibleThread on Swastik Codes. Anyone who controls visiblethread.com can claim the profile by adding a DNS TXT record.
What is the base URL of the VisibleThread API?
Requests go to https://api.visiblethread.com/api/v1. Endpoint paths are added to this base URL.
How do I authenticate with the VisibleThread API?
With an API key in the apiKey header.
How many endpoints does the VisibleThread API have?
12 operations on 8 paths (8 GET, 4 POST). The largest groups are Documents, Webscans.
Is forking the VisibleThread API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.