Sign in

Lists chunks for a document

get/api/v1/{context_id}/documents/{id}/chunks

Path parameters

context_idstring required

Spectron context id

idstring required

Document id fragment

Query parameters

limitinteger

Max chunks to return (default 100, max 500)

cursorstring

Continuation token from the previous page's page.nextCursor

countboolean

Also return page.totalSize (costs a full count of the document's chunks)

pageinteger

Deprecated: zero-based page index. Use cursor.

pageSizeinteger

Deprecated: page size. Use limit.

Response

Changes

Changed in 3 of the 5 revisions of this API.329

  • 9f159871306737See the full diff
    • ▲

      the page response's property type/format changed from integer/int32 to object/ for status 200

      response-property-type-changed

    • ▲

      removed the required property pageSize from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property total from the response with the 200 status

      response-required-property-removed

    • ○

      added the new optional query request parameter count

      new-optional-request-parameter

    • ○

      added the new optional query request parameter cursor

      new-optional-request-parameter

    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property page/nextCursor to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property page/totalSize to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property page/hasMore to the response with the 200 status

      response-required-property-added

  • 52b41ab517b611See the full diff
    • ●

      deleted the query request parameter page_size

      request-parameter-removed

    • ○

      added the new optional query request parameter pageSize

      new-optional-request-parameter

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 741d58b9ef8911See the full diff
    • ●

      deleted the query request parameter pageSize

      request-parameter-removed

    • ○

      added the new optional query request parameter page_size

      new-optional-request-parameter

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog