Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

ProWritingAid.SDK

Build status

C# library for the ProWritingAid.API

Frameworks supported

  • .NET 4.5 or later

Dependencies

The DLLs included in the package may not be the latest version. We recommned using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

Installation

Install SDK using Nuget package.

Getting Started

using System;
using System.Collections.Generic;
using System.Diagnostics;
using ProWritingAid.SDK.Api;
using ProWritingAid.SDK.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
                
            var api = new TextAsyncApi()
                .SetLicenseCode("00000000-0000-0000-0000-2212FC205139");
            var request = new TextAnalysisRequest(
                "I couldnt wait any any longer, I new what I hadd to do",
                new List<string> {"grammar"},
                TextAnalysisRequest.StyleEnum.General,
                TextAnalysisRequest.LanguageEnum.En); 
    
            try
            {
                var response = api.Post(request);
                Debug.WriteLine(response);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TextApi.TextPost: " + e.Message );
            }
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
ContextualThesaurusApi Get GET /api/async/contextualthesaurus/result/{taskId} Tries to get the result of a request using the task id of the request
ContextualThesaurusApi Post POST /api/async/contextualthesaurus Analyses text and returns contextual thesaurus entries
HtmlApi Get GET /api/async/html/result/{taskId} Tries to get the result of a request using the task id of the request
HtmlApi Post POST /api/async/html Analyses HTML and adds suggestion tags to it
SummaryApi Get GET /api/async/summary/result/{taskId} Tries to get the result of a request using the task id of the request
SummaryApi Post POST /api/async/summary Gets the summary analysis of a document
TextApi Get GET /api/async/text/result/{taskId} Tries to get the result of a request using the task id of the request
TextApi Post POST /api/async/text Analyses text and returns tags for it
ThesaurusApi Post POST /api/thesaurus Returns the thesaurus entries for a specific word
WordCloudApi Get GET /api/async/wordcloud/result/{taskId} Tries to get the result of a request using the task id of the request
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

About

Official C# SDK. Grammar checking API for C# and .NET. Also includes: style improvements, terminology checking, and plagiarism checking API.

Topics

Resources

License

Releases

No releases published

Packages

No packages published

Languages

You can’t perform that action at this time.