generation

Summarize text

Summarize a longer text, webpage or email thread (HTML input is accepted and flattened). Returns a prose summary plus a key_points list, sized by the optional length option.

post/api/v1/summarize

Request

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

OR

Response

Successful response. Field-level schemas and examples: https://sapling.ai/docs/api/summarize/ A batch (texts) request answers {"results": [...]} instead: one single-text response per input text, in input order.

resultsobject[]

Present only for a batch (texts) request: one entry per input text, in input order, each shaped exactly like the single-text response.

Changes

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