Mixpeek icon

Mixpeek

Interact with Mixpeek multimodal data processing and semantic search API

Actions50

Document → List

AI-generated

Summary

List documents within a specified collection, supporting pagination to control the number and offset of returned documents.

Inputs

  • Collection ID (required) — The unique identifier of the collection containing the documents to list.
  • Pagination — Optional parameters to control pagination, including 'Limit' (maximum number of items to return, default 50), 'Offset' (number of items to skip, default 0), and 'Cursor' (pagination cursor for the next page).

Output shape

a list of document records returned as JSON objects in an array format

The API response includes the documents from the specified collection according to the pagination parameters. Use 'Limit' and 'Offset' or 'Cursor' to paginate through results. If an error occurs per item and 'Continue On Fail' is enabled, error details will be returned as JSON for that item.

Links

Discussion