proofreading

Record a rejected edit

Report that the user rejected a suggestion returned by /api/v1/edits or /api/v1/spellcheck; similar suggestions are then suppressed for that user. The body must be a non-empty JSON object; include user_id or the feedback is not recorded.

post/api/v1/edits/{edit_hash}/reject

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/edits/{edit_hash}/reject
  • Auth: one of:
    • HTTP bearer
    • none

Path parameters

edit_hashstring uuid required

The edit's id from /edits.

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.

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 session identifier used to group feedback events.

user_idstring

Your identifier for the end user. The feedback is acknowledged but NOT recorded when omitted.

Response

Acknowledged.

result'success'

Changes

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