Lists Layer 0 knowledge documents
Path parameters
Spectron context id
Query parameters
Filter by document status
Filter by mime type
Max documents to return (default 100, max 500)
Continuation token from the previous page's page.nextCursor
Also return page.totalSize (costs a full count of the filtered set)
Deprecated: zero-based page index. Use cursor.
Deprecated: page size. Use limit.
Response
Documents
Changes
Changed in 3 of the 5 revisions of this API.3715
- ▲
the
pageresponse's property type/format changed frominteger/int32toobject/for status200response-property-type-changed
- ▲
removed the required property
pageSizefrom the response with the200statusresponse-required-property-removed
- ▲
removed the required property
totalfrom the response with the200statusresponse-required-property-removed
- ○
added the new optional
queryrequest parametercountnew-optional-request-parameter
- ○
added the new optional
queryrequest parametercursornew-optional-request-parameter
- ○
added the new optional
queryrequest parameterlimitnew-optional-request-parameter
- ○
added the non-success response with the status
503response-non-success-status-added
- ○
added the optional property
documents/items/observedAtto the response with the200statusresponse-optional-property-added
- ○
added the optional property
page/nextCursorto the response with the200statusresponse-optional-property-added
- ○
added the optional property
page/totalSizeto the response with the200statusresponse-optional-property-added
- ○
added the required property
page/hasMoreto the response with the200statusresponse-required-property-added
- ▲
- ●
deleted the
queryrequest parametermime_typerequest-parameter-removed
- ●
deleted the
queryrequest parameterpage_sizerequest-parameter-removed
- ●
removed the optional property
documents/items/chunkCountfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
documents/items/keywordCountfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
documents/items/languagefrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional
queryrequest parametermimeTypenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterpageSizenew-optional-request-parameter
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
deleted the
queryrequest parametermimeTyperequest-parameter-removed
- ●
deleted the
queryrequest parameterpageSizerequest-parameter-removed
- ○
added the new optional
queryrequest parametermime_typenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterpage_sizenew-optional-request-parameter
- ○
added the optional property
documents/items/chunkCountto the response with the200statusresponse-optional-property-added
- ○
added the optional property
documents/items/keywordCountto the response with the200statusresponse-optional-property-added
- ○
added the optional property
documents/items/languageto the response with the200statusresponse-optional-property-added
This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●