generation

Autocomplete a sentence

Predict how a partially written sentence continues. Send the trailing text the user has typed as query (200 characters maximum) and the tool returns the predicted continuation. Requires an API key with autocomplete enabled; other keys get an explicit error back.

post/api/v1/complete

Request

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

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.

querystring required

The partial text to continue, at most 200 characters. Send the end of what the user has typed, not the whole document.

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 stable identifier for the document or conversation being written.

Response

Successful response. Field-level schemas and examples: https://sapling.ai/docs/api/autocomplete/ An empty JSON array is returned when no completion is available (prediction failed or was shorter than the minimum length).

Changes

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