pro_writing_aid_api

ProWritingAid.API

Official ProWritingAid API Version 2

• API version: v2
• Package version: 2.0.0

Installation

For Node.js

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'd like to by that toy. wood you help me? I have twp more brothers.",
  ['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://localhost:5004

Class	Method	HTTP request	Description
ProWritingAidApiV2.ContextualThesaurusApi	get	GET /api/async/contextualthesaurus/result/{taskId}
ProWritingAidApiV2.ContextualThesaurusApi	post	POST /api/async/contextualthesaurus
ProWritingAidApiV2.HtmlApi	get	GET /api/async/html/result/{taskId}
ProWritingAidApiV2.HtmlApi	post	POST /api/async/html
ProWritingAidApiV2.SummaryApi	get	GET /api/async/summary/result/{taskId}
ProWritingAidApiV2.SummaryApi	post	POST /api/async/summary
ProWritingAidApiV2.TextApi	get	GET /api/async/text/result/{taskId}
ProWritingAidApiV2.TextApi	post	POST /api/async/text
ProWritingAidApiV2.ThesaurusApi	post	POST /api/thesaurus	Returns the thesaurus entries for a specific word
ProWritingAidApiV2.WordCloudApi	get	GET /api/async/wordcloud/result/{taskId}
ProWritingAidApiV2.WordCloudApi	post	POST /api/async/wordcloud

Documentation for Models

• ProWritingAidApiV2.AnalysisSettings
• ProWritingAidApiV2.AnalysisSummary
• ProWritingAidApiV2.AnalysisSummaryGraph
• ProWritingAidApiV2.AnalysisSummaryGraphItem
• ProWritingAidApiV2.AnalysisSummaryItem
• ProWritingAidApiV2.AnalysisSummarySubItem
• ProWritingAidApiV2.AsyncResponseContextualThesaurusResponse
• ProWritingAidApiV2.AsyncResponseHtmlAnalysisResponse
• ProWritingAidApiV2.AsyncResponseSummaryAnalysisResponse
• ProWritingAidApiV2.AsyncResponseTextAnalysisResponse
• ProWritingAidApiV2.AsyncResponseWordCloudResponse
• ProWritingAidApiV2.ContextualThesaurusRequest
• ProWritingAidApiV2.ContextualThesaurusResponse
• ProWritingAidApiV2.DocTag
• ProWritingAidApiV2.EntryMeaning
• ProWritingAidApiV2.HtmlAnalysisRequest
• ProWritingAidApiV2.HtmlAnalysisResponse
• ProWritingAidApiV2.SuggestionCategory
• ProWritingAidApiV2.SummaryAnalysisRequest
• ProWritingAidApiV2.SummaryAnalysisResponse
• ProWritingAidApiV2.TextAnalysisRequest
• ProWritingAidApiV2.TextAnalysisResponse
• ProWritingAidApiV2.ThesaurusRequest
• ProWritingAidApiV2.ThesaurusResponse
• ProWritingAidApiV2.WordCloudRequest
• ProWritingAidApiV2.WordCloudResponse

Documentation for Authorization

licenseCode

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