analysis

Delete a style-guide rule set

Delete a saved rule set by name. The name may be sent as a query parameter or as name in a JSON body.

delete/api/v1/styleguide/rulesets

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/styleguide/rulesets
  • Auth: one of:
    • HTTP bearer
    • none

Query parameters

namestring

Rule set name (alternatively in the body).

keystring

Sapling API key, as an alternative to the "Authorization: Bearer <key>" header.

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.

namestring
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.

Response

Deleted.

deletedstring

Changes

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