Git Product home page Git Product logo

pavel-shirobok / prowritingaid.javascript Goto Github PK

View Code? Open in Web Editor NEW

This project forked from prowriting/prowritingaid.javascript

0.0 1.0 0.0 147 KB

Official Javascript SDK for ProWritingAid. Grammar checking API for Javascript. Also includes: style improvements, terminology checking, and plagiarism checking API.

Home Page: https://prowritingaid.com/en/App/Api

License: Apache License 2.0

Shell 0.80% JavaScript 99.20%

prowritingaid.javascript's Introduction

ProWritingAid.API

Official ProWritingAid API Version 2

  • API version: v2
  • Package version: 2.0.0

Installation

npm

Install package using command:

npm install pro_writing_aid_api --save

git

Or install package from the git repo:

npm install prowriting/prowritingaid.javascript --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var ProWritingAidApi = require('pro_writing_aid_api');

var api = new ProWritingAidApi.TextApi();
api.apiClient.basePath="https://api.prowritingaid.com";
api.apiClient.defaultHeaders={'licenseCode': 'your license code'}
var request = new ProWritingAidApi.TextAnalysisRequest(
  "I couldnt wait any any longer, I new what I hadd to do",
  ['grammar'],
  "General",
  "En"
);
api.post(request)
  .then(function(data) {
    console.log('API called successfully. Returned data: ');
    console.log(data);
  }, function(error) {
    console.error(error);
  });

Documentation for API Endpoints

All URIs are relative to https://api.prowritingaid.com

Class Method HTTP request Description
ProWritingAidApi.ContextualThesaurusApi get GET /api/async/contextualthesaurus/result/{taskId} Tries to get the result of a request using the task id of the request
ProWritingAidApi.ContextualThesaurusApi post POST /api/async/contextualthesaurus Analyses text and returns contextual thesaurus entries
ProWritingAidApi.HtmlApi get GET /api/async/html/result/{taskId} Tries to get the result of a request using the task id of the request
ProWritingAidApi.HtmlApi post POST /api/async/html Analyses HTML and adds suggestion tags to it
ProWritingAidApi.SummaryApi get GET /api/async/summary/result/{taskId} Tries to get the result of a request using the task id of the request
ProWritingAidApi.SummaryApi post POST /api/async/summary Gets the summary analysis of a document
ProWritingAidApi.TextApi get GET /api/async/text/result/{taskId} Tries to get the result of a request using the task id of the request
ProWritingAidApi.TextApi post POST /api/async/text Analyses text and returns tags for it
ProWritingAidApi.ThesaurusApi post POST /api/thesaurus Returns the thesaurus entries for a specific word
ProWritingAidApi.WordCloudApi get GET /api/async/wordcloud/result/{taskId} Tries to get the result of a request using the task id of the request
ProWritingAidApi.WordCloudApi post POST /api/async/wordcloud Analyses text and returns a word cloud (as an image)

Documentation for Models

Documentation for Authorization

licenseCode

  • Type: API key
  • API key parameter name: licenseCode
  • Location: HTTP header

prowritingaid.javascript's People

Contributors

dmit25 avatar pedroroquette avatar pedroroquette-toptal avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.