files

Split text into chunks

Split long text into overlapping chunks no longer than max_length, preferring sentence and whitespace boundaries. Not billed.

post/api/v1/ingest/chunk_text

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/ingest/chunk_text
  • Auth: one of:
    • HTTP bearer
    • 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.

max_lengthinteger required

Maximum chunk length in characters. Required in practice: omitting it answers 400.

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.

step_sizeinteger

Characters to advance between chunk starts; 0 means 10% of max_length.

textstring required

Response

Chunks in document order.

chunksstring[]

Changes

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