analysis

Check text against a style guide

Check a text for compliance with caller-supplied style rules (house style, brand voice, editorial guidelines). Returns violations — each with the verbatim offending passage, its start/end offsets in the submitted text (null when the passage cannot be located), the violated rule name, a brief note and a compliant rewrite suggestion — plus a top-level compliant boolean. Only the listed rules are enforced; an empty violations list means the text complies. The text is checked as submitted (markup included), so offsets always index it directly. Provide exactly one of rules (inline) or ruleset (the name of a rule set saved via the API).

post/api/v1/styleguide

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/styleguide
  • 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

OR
OR
OR

Response

Successful response. Field-level schemas and examples: https://sapling.ai/docs/api/styleguide/ A batch (texts) request answers {"results": [...]} instead: one single-text response per input text, in input order.

resultsobject[]

Present only for a batch (texts) request: one entry per input text, in input order, each shaped exactly like the single-text response.

Changes

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