SUsurrealdb

GET /api/v1/{context_id}/documents

Changed on

Lists Layer 0 knowledge documents

Request

Path parameters

context_idstring required

Spectron context id

Query parameters

statusstring

Filter by document status

mimeTypestring

Filter by mime type

limitinteger

Max documents 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 filtered set)

pageinteger

Deprecated: zero-based page index. Use cursor.

pageSizeinteger

Deprecated: page size. Use limit.

Response

Documents

Changes

  • 9f1598713067Revision 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 optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • 52b41ab517b6Revision changes
    • warning

      deleted the query request parameter mime_type

    • warning

      deleted the query request parameter page_size

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter mimeType

    • info

      added the new optional query request parameter pageSize