https://github.com/prowriting/prowritingaid.csharp
Official C# SDK. Grammar checking API for C# and .NET. Also includes: style improvements, terminology checking, and plagiarism checking API.
https://github.com/prowriting/prowritingaid.csharp
api csharp grammar prowriting prowritingaid sdk style
Last synced: 6 months ago
JSON representation
Official C# SDK. Grammar checking API for C# and .NET. Also includes: style improvements, terminology checking, and plagiarism checking API.
- Host: GitHub
- URL: https://github.com/prowriting/prowritingaid.csharp
- Owner: prowriting
- License: apache-2.0
- Created: 2017-07-03T12:32:43.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T14:46:24.000Z (over 3 years ago)
- Last Synced: 2025-12-10T17:28:34.095Z (7 months ago)
- Topics: api, csharp, grammar, prowriting, prowritingaid, sdk, style
- Language: C#
- Homepage: https://prowritingaid.com/en/App/Api
- Size: 204 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ProWritingAid.SDK
[](https://ci.appveyor.com/project/prowriting/prowritingaid-csharp)
C# library for the ProWritingAid.API
- API version: v2
- SDK version: 2.0.15
- [Nuget package](https://www.nuget.org/packages/ProWritingAid.SDK/)
For more information, please visit [https://prowritingaid.com/en/App/API#c-charp](https://prowritingaid.com/en/App/API#c-charp)
## Frameworks supported
- .NET standard 2.0
## Dependencies
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.1 or later
The DLLs included in the package may not be the latest version. We recommend 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](https://www.nuget.org/packages/ProWritingAid.SDK/).
## Getting Started
```csharp
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 {"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**](docs/ContextualThesaurusApi.md#get) | **GET** /api/async/contextualthesaurus/result/{taskId} | Tries to get the result of a request using the task id of the request
*ContextualThesaurusApi* | [**Post**](docs/ContextualThesaurusApi.md#post) | **POST** /api/async/contextualthesaurus | Analyses text and returns contextual thesaurus entries
*HtmlApi* | [**Get**](docs/HtmlApi.md#get) | **GET** /api/async/html/result/{taskId} | Tries to get the result of a request using the task id of the request
*HtmlApi* | [**Post**](docs/HtmlApi.md#post) | **POST** /api/async/html | Analyses HTML and adds suggestion tags to it
*SummaryApi* | [**Get**](docs/SummaryApi.md#get) | **GET** /api/async/summary/result/{taskId} | Tries to get the result of a request using the task id of the request
*SummaryApi* | [**Post**](docs/SummaryApi.md#post) | **POST** /api/async/summary | Gets the summary analysis of a document
*TextApi* | [**Get**](docs/TextApi.md#get) | **GET** /api/async/text/result/{taskId} | Tries to get the result of a request using the task id of the request
*TextApi* | [**Post**](docs/TextApi.md#post) | **POST** /api/async/text | Analyses text and returns tags for it
*ThesaurusApi* | [**Post**](docs/ThesaurusApi.md#post) | **POST** /api/thesaurus | Returns the thesaurus entries for a specific word
*WordCloudApi* | [**Get**](docs/WordCloudApi.md#get) | **GET** /api/async/wordcloud/result/{taskId} | Tries to get the result of a request using the task id of the request
*WordCloudApi* | [**Post**](docs/WordCloudApi.md#post) | **POST** /api/async/wordcloud | Analyses text and returns a word cloud (as an image)
- [Model.AnalysisSettings](docs/AnalysisSettings.md)
- [Model.AnalysisSummary](docs/AnalysisSummary.md)
- [Model.AnalysisSummaryGraph](docs/AnalysisSummaryGraph.md)
- [Model.AnalysisSummaryGraphItem](docs/AnalysisSummaryGraphItem.md)
- [Model.AnalysisSummaryItem](docs/AnalysisSummaryItem.md)
- [Model.AnalysisSummarySubItem](docs/AnalysisSummarySubItem.md)
- [Model.AsyncResponseContextualThesaurusResponse](docs/AsyncResponseContextualThesaurusResponse.md)
- [Model.AsyncResponseHtmlAnalysisResponse](docs/AsyncResponseHtmlAnalysisResponse.md)
- [Model.AsyncResponseSummaryAnalysisResponse](docs/AsyncResponseSummaryAnalysisResponse.md)
- [Model.AsyncResponseTextAnalysisResponse](docs/AsyncResponseTextAnalysisResponse.md)
- [Model.AsyncResponseWordCloudResponse](docs/AsyncResponseWordCloudResponse.md)
- [Model.ContextualThesaurusRequest](docs/ContextualThesaurusRequest.md)
- [Model.ContextualThesaurusResponse](docs/ContextualThesaurusResponse.md)
- [Model.DocTag](docs/DocTag.md)
- [Model.EntryMeaning](docs/EntryMeaning.md)
- [Model.HtmlAnalysisRequest](docs/HtmlAnalysisRequest.md)
- [Model.HtmlAnalysisResponse](docs/HtmlAnalysisResponse.md)
- [Model.SuggestionCategory](docs/SuggestionCategory.md)
- [Model.SummaryAnalysisRequest](docs/SummaryAnalysisRequest.md)
- [Model.SummaryAnalysisResponse](docs/SummaryAnalysisResponse.md)
- [Model.TextAnalysisRequest](docs/TextAnalysisRequest.md)
- [Model.TextAnalysisResponse](docs/TextAnalysisResponse.md)
- [Model.ThesaurusRequest](docs/ThesaurusRequest.md)
- [Model.ThesaurusResponse](docs/ThesaurusResponse.md)
- [Model.WordCloudRequest](docs/WordCloudRequest.md)
- [Model.WordCloudResponse](docs/WordCloudResponse.md)
## Documentation for Authorization
- **Type**: API key
- **API key parameter name**: licenseCode
- **Location**: HTTP header