Getting Started

Get the Text Editor SDK up and running in your app in just a few steps. Below is an overview of how to create an application.

Apply now for early access to the Text Editor SDK.

Create an application

From the My Applicationsopen in new window tab, create an application and give it a name, such as “Grammarbot” or “Grammarbot Development”. You can edit your application name anytime, and set a public display name later if you’re allowing users to connect their Grammarly accounts.

Install the Text Editor SDK

Once your new application is created, your browser will navigate you to a "Quick Start" tab of your application page.

This guide will educate you on how to add Text Editor SDK to your codebase and enable Grammarly writing on desired text fields by providing installation commands and code snippets you can copy.

Grammarly quick start guide

Dive deeper into installation and usage options for the supported platforms below:

Make sure to turn off the Grammarly Extension in your browser to use the SDK.

Set up credentials

On the "Credentials" tab of your application page you will find your application's client ID. The client ID is the unique public identifieropen in new window for your application. You will need it when initializing the Text Editor SDK in your application. Code examples on your application's "Quick Start" tab will already contain your application's client ID.

On the "Credentials" tab you can also configure your web application's allowed originsopen in new window. Grammarly will only allow the origins that you configure here to communicate with Grammarly's cloud using your application's client ID. You can add multiple allowed origins for your application. Each origin must include the protocol (http:// or https://) and domain; you may optionally specify a port.

Origins can also include the wildcard character * to permit all requests originating from your domain, for example https://*.example.com. You can also use the wildcard :* to allow communication from any port, for example https://www.example.com:*.

Grammarly quick start guide

When you create a new application, Grammarly automatically adds http://localhost:* and http://127.0.0.1:* to the origins list to simplify development. You may remove these origins once you are ready to move your application into production and block requests from localhost origins.

Last Updated: 10/6/2021, 8:32:35 PM