proofreading

Spelling-only check

Check text for spelling errors only (no grammar or style suggestions). Returns edits in the same format as sapling_grammar_check. Faster and cheaper than a full grammar check when only misspellings matter. A result carrying a degraded object is partial; call again for a complete result.

post/api/v1/spellcheck

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/spellcheck
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.sapling.ai/oauth/authorize, token URL https://api.sapling.ai/oauth/token, scopes: sapling:api)
    • none

Request body

keystring

Sapling API key. Required when no "Authorization: Bearer <key>" header is sent; when both are sent, the body key takes precedence over the header.

langstring

ISO 639-1 language code of the text. Defaults to "en".

return_usageboolean

When true, a successful JSON-object response additionally carries "usage": {"characters": <n>} — the billable character count this request submitted (0 for unbilled requests; the 2.5x adjustment for logographic languages is included, so CJK requests report more than their raw length). Repeat texts inside the billing deduplication window are still counted here even though they are not re-charged, so the number is an upper bound on the final charge. Responses whose body is not a JSON object (e.g. bare-array response formats) cannot carry the field. An existing usage field (such as account/status or completion token usage) is preserved unchanged.

session_idstring

Optional stable identifier for the document being checked.

textstring required

The text to process. Plain text or HTML (tags are handled server-side).

Response

Successful response. Field-level schemas and examples: https://sapling.ai/docs/api/spellcheck/ With noformat=true (the SDK response shape) the body is a bare array of edit objects instead. A partial result (some corrections may be missing) adds a degraded object; retry for a complete result.

Changes

No recorded changes to this operation across all 1 revision of this API.