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

Lists chunks for a document

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/surrealdb/apis/spectron/docs/api/v1/:context_id/documents/:id/chunks/get.ts
A function with typed inputs. Its response is checked against the schema.

context_idstring required

Spectron context id

idstring required

Document id fragment

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.

Aug 24, 20269f1598713067 Revision changes
- breaking
  the response's property type changed from integer to object, and format from int32 to no format for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added the new optional query request parameter count
- info
  added the new optional query request parameter cursor
- info
  added the new optional query request parameter limit
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the required property / to the response with the status
Jun 16, 202652b41ab517b6 Revision changes
- warning
  deleted the query request parameter page_size
- info
  added the new optional query request parameter pageSize