proofreading

Add a custom mapping

Suggest mapping whenever entry appears in checked text.

post/api/v1/custom_mapping

Request

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

Request body

case_sensitiveboolean

Whether matching is case sensitive. Defaults to true.

descriptionstring

Shown to the user with the suggestion.

entrystring required
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.

mappingstring required
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

The created mapping.

case_sensitiveboolean
created_atstring

RFC 1123 timestamp, e.g. "Wed, 07 Oct 2020 21:15:47 GMT".

descriptionunknown
entrystring
idstring uuid
mappingstring
updated_atstring

RFC 1123 timestamp.

Changes

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