proofreading

Delete a custom dictionary entry

Remove an entry by the id returned when listing or adding it.

delete/api/v1/dictionary/{entry_id}

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/dictionary/{entry_id}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter key

Path parameters

entry_idstring uuid required

Dictionary entry id.

Query parameters

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. Empty body.

Changes

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