proofreader-api

Integrate the browser-based Proofreader API for live proofreading in web applications.

46|4|Updated Mar 14, 2026
One-click install
npx skills add https://github.com/webmaxru/agent-skills --skill proofreader-api-webmaxru
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: proofreader-api
Source: https://github.com/webmaxru/agent-skills/tree/main/skills/proofreader-api
Command: npx skills add https://github.com/webmaxru/agent-skills --skill proofreader-api-webmaxru

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Enables browser-based Proofreader API integration for live proofreading in web applications, helping developers add accurate grammar, spelling, and style checks without server-side processing.

Core Features & Use Cases

  • Availability checks and guarded session creation to manage model downloads and permissions.
  • Session-based proofreading with correctedInput and a structured corrections array, including optional explanations when supported.
  • Clear fallbacks for unsupported browsers and preview limitations, with guidance for edge-case handling.

Quick Start

Check Proofreader.availability for your environment, then call Proofreader.create with your options, and finally call session.proofread on user input.

Frequently Asked Questions about proofreader-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enable browser-based proofreading for user-provided text?

Browser-based proofreading uses the Proofreader API to check user-provided text. You check Proofreader.availability, create a guarded session, and call session.proofread to get correctedInput and a structured corrections array without server-side processing.

Does the Proofreader API require a secure context to run?

Yes, the Proofreader API requires a secure context and a supported browser with preview features enabled. You must perform availability checks before session creation to handle unsupported browsers and manage preview limitations gracefully.

How do I manage model downloads when creating a proofreading session?

Guarded session creation handles model downloads by monitoring the process during Proofreader.create. You verify availability first, then manage the download lifecycle before executing live proofreading on user input within your web application.

Can I specify expected input languages and correction types for live proofreading?

Yes, live proofreading supports options like expectedInputLanguages, includeCorrectionTypes, includeCorrectionExplanations, and correctionExplanationLanguage. These parameters configure session-based proofreading to return targeted correctedInput and structured correction explanations.

How do I handle permissions-policy for the Proofreader API in web applications?

Permissions-policy handling for the Proofreader API ensures proper access control for user-provided text. You configure policy rules alongside availability checks and session creation to maintain secure, browser-based live proofreading without server-side processing.

What lifecycle methods are available for the Proofreader API?

The Proofreader API lifecycle methods include availability, create, proofread, measureInputUsage, and destroy. These methods manage the full session flow from checking environment support to cleaning up resources after applying grammar and spelling checks.