# Sapling.ai Developer Documentation

> API and SDK documentation for Sapling.ai: grammar/spell checking, autocomplete, AI content detection, paraphrasing, and language tools via HTTP API and JavaScript/Python SDKs.


## docs

API Overview  

- [Welcome](https://sapling.ai/docs.md): API Overview  

### api

Overview of the Sapling.ai API offerings.

- [API Overview](https://sapling.ai/docs/api.md): Overview of the Sapling.ai API offerings.
- [Account Status](https://sapling.ai/docs/api/account-status.md): One-call self-diagnosis for a Sapling API key — whether it can make billable calls right now, why not, and when a block clears.
- [Advanced Edits](https://sapling.ai/docs/api/advanced-edits.md): Sapling provides customizable proofreading settings that go beyond regular spelling and grammar checking. These include suggestions around making text simpler and more confident, as well as edits around DEI. The Advanced Edits settings are configurable for your account (here) as well as on a per API call level (documented below) because these suggestions may not be applicable to all styles of writing. Advanced Edits are currently only available for English.
- [Analysis](https://sapling.ai/docs/api/analysis.md): The Analysis endpoints compute syntactic information about the input text. Outputs include:
- [API Access](https://sapling.ai/docs/api/api-access.md): Anyone can test out Sapling's API. To get started with the API, simply:
- [API Reporting](https://sapling.ai/docs/api/api-reporting.md): Sapling's API endpoints for retrieving API usage analytics, plus the
- [Applying Edits](https://sapling.ai/docs/api/applying-edits.md): After you've sent the Sapling API text and gotten JSON edits in the response, how do you apply the edits to get updated text?
- [Autocomplete](https://sapling.ai/docs/api/autocomplete.md): Sapling's autocomplete provides predictions of the next few characters or words
- [Chunking](https://sapling.ai/docs/api/chunk.md): Also refered to as segmentation, chunking text allows you to parallelize
- [Text Classification API](https://sapling.ai/docs/api/classify.md): The classify endpoint sorts a piece of text into labels you define in the request — no training data,
- [5 Best Grammar and Spell Checking APIs / SDKs](https://sapling.ai/docs/api/comparison.md): Looking for a grammar check API? A comparison of 5 grammar and spell checking APIs — Bing, Ginger, LanguageTool, ProWritingAid, and Sapling — with features, latency, and drawbacks of each.
- [advanced_edits](https://sapling.ai/docs/api/components/advanced_edits.md): Sample Response
- [ai_detector](https://sapling.ai/docs/api/components/ai_detector.md): Sample Code
- [apply_edit_javascript](https://sapling.ai/docs/api/components/apply_edit_javascript.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [apply_edit_php](https://sapling.ai/docs/api/components/apply_edit_php.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [apply_edit_python](https://sapling.ai/docs/api/components/apply_edit_python.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [apply_edit](https://sapling.ai/docs/api/components/apply_edit.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [chunk_file_python](https://sapling.ai/docs/api/components/chunk_file_python.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [dei_edits](https://sapling.ai/docs/api/components/dei_edits.md): Sample Code
- [tone](https://sapling.ai/docs/api/components/tone.md): Sample Code
- [Custom Mappings](https://sapling.ai/docs/api/custom-mappings.md): Custom Mappings can be used to enforce specific corrections or capitalization for the following purposes:
- [AI Detector API](https://sapling.ai/docs/api/detector.md): Sapling's AI detector API scores how likely text is AI-generated, at the document, sentence, and token level. REST endpoint plus Python and JavaScript SDKs.
- [Dictionary](https://sapling.ai/docs/api/dictionary.md): Add terms such as industry-specific jargon or product names to your dictionary so that Sapling will ignore these terms. The dictionary can also be managed in your web dashboard.
- [Grammar Check API](https://sapling.ai/docs/api/edits-overview.md): Sapling's grammar check API returns grammar, spelling, and style corrections as JSON edits with character offsets and error types. REST endpoint plus Python and JavaScript SDKs.
- [Error Categories](https://sapling.ai/docs/api/error-categories.md): Error categories are returned as part of the Edits API. They provide additional classification and detail on the types of edits that Sapling suggests. These categories can be used for analysis, reporting, or coaching purposes.
- [Benchmarking & Evaluation](https://sapling.ai/docs/api/evaluation.md): How do you determine whether one NLP system that suggests edits
- [Data Extraction API](https://sapling.ai/docs/api/extract.md): The extract endpoint pulls fields you name out of unstructured text — invoices, emails, resumes,
- [Files](https://sapling.ai/docs/api/files.md): In addition to plain text, Sapling also supports PDF and DOCX processing
- [Handling Fragments](https://sapling.ai/docs/api/fragments.md): Sometimes the text in requests may not be full sentences but instead
- [Guardrails](https://sapling.ai/docs/api/guardrails.md): Despite their amazing capabilities, LLMs can often behave in undesired
- [Inclusive Language API](https://sapling.ai/docs/api/inclusive.md): The Inclusive Language endpoint finds non-inclusive or biased wording in a text: gendered defaults
- [Language Detection API](https://sapling.ai/docs/api/langdetect.md): The language detection endpoint identifies the language of a given text and returns a confidence score.
- [Named-Entity Recognition API](https://sapling.ai/docs/api/ner.md): The NER endpoint finds named entities in a text — people, organizations, locations, dates, times,
- [5 Best Paraphrase APIs](https://sapling.ai/docs/api/paraphrase-comparison.md): Looking for a paraphrasing API? Here's a comparison of 5 different API services along with the features, benefits, and drawbacks of each service.
- [PII Detection & Redaction API](https://sapling.ai/docs/api/pii.md): The PII endpoint finds personally identifiable information in a text — email addresses, phone numbers,
- [Postprocessing](https://sapling.ai/docs/api/postprocess.md): The Postprocess endpoint performs a variety of operations that are useful
- [Preprocessing Overview](https://sapling.ai/docs/api/preprocess-overview.md): Ingestion + Extraction
- [Profanity Filter API](https://sapling.ai/docs/api/profanity.md): The profanity API checks for profanity in the given text - it provides a 0/1 label for each token, where 1 indicates profanity was detected.
- [Quality Score](https://sapling.ai/docs/api/quality.md): The quality endpoint computes a writing-quality score for a given text.
- [Rephrase](https://sapling.ai/docs/api/rephrase.md): The Paraphrase and Rephrase endpoints offer paraphrasing for particular styles.
- [Content Safety API](https://sapling.ai/docs/api/safety.md): The content safety endpoint scores a text on seven moderation categories —
- [Semantic Search](https://sapling.ai/docs/api/semsearch.md): Semantic search provides the ability to query/search over a set of documents based off the
- [Sentiment Analysis](https://sapling.ai/docs/api/sentiment.md): The sentiment endpoint checks the sentiment for a given text - positive, negative, or neutral.
- [SEO Analysis API](https://sapling.ai/docs/api/seo.md): The SEO endpoint analyzes a page or article and returns everything needed to publish it well:
- [Similar Terms](https://sapling.ai/docs/api/similar-terms.md): Many times you may need to find terms that have a similar meaning to another term.
- [Plain Language Simplification API](https://sapling.ai/docs/api/simplify.md): The simplify endpoint rewrites a text in plain language at a reading level you choose — for
- [Service Level Agreement (“SLA”)](https://sapling.ai/docs/api/sla.md): Definitions
- [Spellcheck](https://sapling.ai/docs/api/spellcheck.md): For some use cases, grammar and phrase-level edits may not be necessary.
- [Statistics](https://sapling.ai/docs/api/statistics.md): The Statistics endpoint computes simple statistics for a given text document. These statistics include word and sentence counts as well as Flesch-Kincaid score.
- [Style Guide Compliance API](https://sapling.ai/docs/api/styleguide.md): The styleguide endpoint checks a text for compliance with style rules you define in the request —
- [Summarize API](https://sapling.ai/docs/api/summarize.md): The summarize endpoint condenses a longer document — an article, call transcript, meeting notes,
- [Superuser Management](https://sapling.ai/docs/api/superuser-management.md): For changing the team directly through API, the key holder must be an superuser for the deployment.
- [Team Custom Mappings](https://sapling.ai/docs/api/team-custom-mappings.md): API key holder must be an admin for the team to access a team's dictionary.
- [Team Dictionary](https://sapling.ai/docs/api/team-dictionary.md): API key holder must be an admin for the team to access a team's dictionary.
- [Team Reporting](https://sapling.ai/docs/api/team-reporting.md): Sapling's API endpoint for exporting team user activity and analytics. See Team Management for getting the IDs for a particular team.
- [Team Snippets](https://sapling.ai/docs/api/team-snippets.md): Snippets is a way to save time on frequently used pieces of text.
- [User Management](https://sapling.ai/docs/api/team-user-management.md): Teams GET
- [Tone Detection](https://sapling.ai/docs/api/tone.md): The tone endpoint checks the tone for a given text.
- [Transcriptions](https://sapling.ai/docs/api/transcriptions.md): As part of postprocessing, Sapling offers the ability to process
- [Translation API](https://sapling.ai/docs/api/translate.md): The translate endpoint translates text into a target language you name — as an ISO 639 code

### sdk

Overview of the Sapling.ai SDK offerings.

- [SDK Overview](https://sapling.ai/docs/sdk.md): Overview of the Sapling.ai SDK offerings.
- [Deploying to Production](https://sapling.ai/docs/sdk/deploying.md): Here's a sample deployment setup using the JavaScript SDK along with a Python backend.
- [Editors Overview](https://sapling.ai/docs/sdk/editors.md): Overview of the Sapling.ai editor integrations.
- [CKEditor](https://sapling.ai/docs/sdk/Editors/ckeditor.md): Sample Code
- [Froala](https://sapling.ai/docs/sdk/Editors/froala.md): Sample Code
- [Quill](https://sapling.ai/docs/sdk/Editors/quill.md): Sample Code
- [TinyMCE](https://sapling.ai/docs/sdk/Editors/tinymce.md): Sample Code
- [Electron](https://sapling.ai/docs/sdk/electron.md): Electron is a library/framework for building cross-platform desktop apps with JavaScript, HTML, and CSS.
- [AI Detect HTML Quickstart](https://sapling.ai/docs/sdk/HTML/ai_detect_quickstart.md): Here's a minimal webpage using the Sapling SDK that includes a button for AI Detection.
- [HTML Quickstart](https://sapling.ai/docs/sdk/HTML/quickstart.md): The complete JavaScript API can be found under JavaScript -> Frontend Documentation.
- [Accessibility](https://sapling.ai/docs/sdk/Integration Details/accessibility.md): On May 9, 2024, the Department of Health and Human Services
- [Style Customization](https://sapling.ai/docs/sdk/Integration Details/customize.md): For technical support, contact support@sapling.ai.
- [Flagging Issues in Text](https://sapling.ai/docs/sdk/Integration Details/flagging-issues.md): Sapling's API and SDK can be used in a variety of different ways to process text and automatically flag issues. These can range from grammatical mistakes to making writing more confident, concise, or inclusive.
- [Migrating from the Grammarly Text Editor SDK](https://sapling.ai/docs/sdk/Integration Details/grammarly-migration.md): Important: The Grammarly Text Editor SDK will no longer be updated and will be deprecated on January 10, 2024. We suggest removing the integration from your app or website before that date. - Grammarly
- [Salesforce Lightning](https://sapling.ai/docs/sdk/Integration Details/lightning.md): For technical support, contact support@sapling.ai.
- [AI Detect JavaScript Quickstart](https://sapling.ai/docs/sdk/JavaScript/ai_detect_quickstart.md): Javascript SDK for AI Detection
- [Backend Documentation](https://sapling.ai/docs/sdk/JavaScript/backend_documentation.md): Import the Sapling client with:
- [Frontend Documentation](https://sapling.ai/docs/sdk/JavaScript/frontend_documentation.md): The Sapling JavaScript SDK enables easy integration of Sapling's functionality -- such as grammar/spell checking and autocomplete -- in any web application.
- [Frontend Key Management](https://sapling.ai/docs/sdk/JavaScript/frontend_key_management.md): There are two main ways of authenticating SDK server requests without exposing your API key in public environments:
- [JavaScript Quickstart](https://sapling.ai/docs/sdk/JavaScript/quickstart.md): Installation
- [Tone Detection JavaScript Quickstart](https://sapling.ai/docs/sdk/JavaScript/tone_quickstart.md): Javascript SDK for Tone Detection
- [Overview](https://sapling.ai/docs/sdk/overview.md): Sapling has SDKs that assist in grammar checking text for Python and JavaScript, and an HTTP API that is language agnostic.
- [Python Documentation](https://sapling.ai/docs/sdk/Python/documentation.md): The sapling-py package provides a Python wrapper around the Sapling HTTP API.
- [Python Quickstart](https://sapling.ai/docs/sdk/Python/quickstart.md): Installation

### onprem

- [On-Premises Grammar Checkers and Language Model Assistants](https://sapling.ai/docs/onprem/comparison.md): Looking for a self-hosted grammar/spell check tool? Here's a comparison of 5 different products that offer on-premises deployments, along with the benefits and drawbacks of each product.
- [Overview](https://sapling.ai/docs/onprem/overview.md): Self-Hosting

### components

- [advanced_edit](https://sapling.ai/docs/components/advanced_edit.md): Options for advanced edits. Option keys are String, and option values are Boolean.
- [HTML_custom_UI](https://sapling.ai/docs/components/code_samples/HTML_custom_UI.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [HTML_dev](https://sapling.ai/docs/components/code_samples/HTML_dev.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [HTML](https://sapling.ai/docs/components/code_samples/HTML.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [python_proxy](https://sapling.ai/docs/components/code_samples/python_proxy.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [dev_api_key_tip](https://sapling.ai/docs/components/dev_api_key_tip.md): A rate-limited API developer key can be provisioned from the Sapling API dashboard. Developer keys allow for processing of 50,000 characters every 24 hours. Subscribe for production access and usage-based pricing.
- [languages](https://sapling.ai/docs/components/languages.md): Specifies language for grammar and spell checking.
- [varieties](https://sapling.ai/docs/components/varieties.md): This option is currently available for: English, Chinese (中文).

### custom-models

Language Variety

- [Custom Models](https://sapling.ai/docs/custom-models.md): Language Variety

### data

Activation

- [Data Transfer, Processing, & Retention](https://sapling.ai/docs/data.md): Activation

### help

There are several ways to get answers to any questions you have about Sapling.

- [Support](https://sapling.ai/docs/help.md): There are several ways to get answers to any questions you have about Sapling.

### integrations

With developer platforms, there is often a trade-off

- [Other Integrations](https://sapling.ai/docs/integrations.md): With developer platforms, there is often a trade-off

### mcp

Connect Sapling's grammar, AI detection, rephrase, summarization, sentiment, language, PII, quality, SEO, classification and extraction tools to an MCP-compatible AI assistant, hosted or local.

- [Sapling MCP Server](https://sapling.ai/docs/mcp.md): Connect Sapling's grammar, AI detection, rephrase, summarization, sentiment, language, PII, quality, SEO, classification and extraction tools to an MCP-compatible AI assistant, hosted or local.

### openapi

Machine-readable OpenAPI 3.1 description of Sapling's REST API — import it into Postman, generate typed clients, or register Sapling endpoints as tools for ChatGPT Actions and other agent frameworks.

- [OpenAPI Specification](https://sapling.ai/docs/openapi.md): Machine-readable OpenAPI 3.1 description of Sapling's REST API — import it into Postman, generate typed clients, or register Sapling endpoints as tools for ChatGPT Actions and other agent frameworks.

### playground

We noticed that "playground" is a popular term for AI apps in search traffic analytics.

- [Sapling Playground](https://sapling.ai/docs/playground.md): We noticed that "playground" is a popular term for AI apps in search traffic analytics.

### rate_limits

Sapling API rate limits, rate-limit headers, the JSON error format, what each HTTP status means, and when to retry.

- [Rate Limits & Errors](https://sapling.ai/docs/rate_limits.md): Sapling API rate limits, rate-limit headers, the JSON error format, what each HTTP status means, and when to retry.

### sandbox

How to build and test a Sapling API integration safely — the free trial key as a sandbox, zero-cost health checks, which calls change stored state, and moving from test to production.

- [Sandbox & Testing](https://sapling.ai/docs/sandbox.md): How to build and test a Sapling API integration safely — the free trial key as a sandbox, zero-cost health checks, which calls change stored state, and moving from test to production.

### uptime

You can check on the Sapling API status by checking our status page.

- [Status and Uptime](https://sapling.ai/docs/uptime.md): You can check on the Sapling API status by checking our status page.

### usage-pricing

By default, your API key will have a quota of 50,000 characters/day, with 250,000 characters/month. Subscribe for production access and usage-based pricing. Higher usage volumes are discounted. API subscriptions started on or after August 12, 2026 require a one-time \$5 minimum payment at signup; see Billing for details.

- [Usage and Pricing](https://sapling.ai/docs/usage-pricing.md): By default, your API key will have a quota of 50,000 characters/day, with 250,000 characters/month. Subscribe for production access and usage-based pricing. Higher usage volumes are discounted. API subscriptions started on or after August 12, 2026 require a one-time \$5 minimum payment at signup; see Billing for details.

## devblog

Sapling.ai's developer blog.

- [Sapling.ai Dev Blog](https://sapling.ai/devblog.md): Sapling.ai's developer blog.

### archive

Archive

- [Archive](https://sapling.ai/devblog/archive.md): Archive

### authors

Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

- [Authors](https://sapling.ai/devblog/authors.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

### chatgpt-grammar-checking-editing

LLMs such as ChatGPT can be used for grammar checking and editing, but there are challenges to be aware of before deploying such systems to production.

- [ChatGPT as a Grammar Checker and Editor](https://sapling.ai/devblog/chatgpt-grammar-checking-editing.md): LLMs such as ChatGPT can be used for grammar checking and editing, but there are challenges to be aware of before deploying such systems to production.

### chatgpt-phrases

What phrases are used much more frequently by large language models than by people, and what does this reveal about their training process?

- [ChatGPT's Favorite Phrases](https://sapling.ai/devblog/chatgpt-phrases.md): What phrases are used much more frequently by large language models than by people, and what does this reveal about their training process?

### tags

Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

- [Tags](https://sapling.ai/devblog/tags.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.
- [2 posts tagged with "llms"](https://sapling.ai/devblog/tags/llms.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

## search

Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

- [Search the documentation](https://sapling.ai/search.md): Develop AI-powered messaging applications using Sapling.ai's developer platform. Includes grammar/spelling correction and autocomplete through HTTP API or JavaScript SDK.

## Optional
- [Sapling.ai (main site)](https://sapling.ai/): Product overview, live demos, and account signup.
- [Sapling MCP Server Guide](https://sapling.ai/docs/mcp/): Install Sapling grammar, AI detection, and language tools in Claude and other MCP-compatible AI assistants.
- [Sapling OpenAPI Specification](https://api.sapling.ai/openapi.json): Machine-readable OpenAPI 3.1 description of the REST API, for client generators, Postman, and agent frameworks. No API key needed to fetch it.
- [LLM Index](https://sapling.ai/llm/index): Comparison of large language models.
- [API Status](https://sapling.statuspage.io/): Live API uptime and incident history.