Skip to main content
POST
/
v1
/
collections
/
{collection_identifier}
/
documents
/
list
List documents.
curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/list \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "search": "<string>",
  "return_url": true,
  "return_vectors": true
}'
{
  "results": [
    {
      "document_id": "<string>",
      "collection_id": "<string>",
      "object_id": "<string>",
      "enrichments": {
        "clusters": [
          {
            "cluster_id": "cluster_001",
            "coordinates": [
              0.12,
              0.23,
              0.34,
              0.45,
              0.56
            ],
            "distance_to_centroid": 0.15,
            "document_id": "doc_123",
            "features": {
              "category": "electronics",
              "product_name": "Widget A"
            },
            "source_details": {
              "source_id": "col_products_v1",
              "type": "collection"
            }
          }
        ],
        "taxonomies": [
          {
            "label": "Mobile Phones",
            "node_id": "node_electronics_phones",
            "path": [
              "products",
              "electronics",
              "phones"
            ],
            "score": 0.87,
            "taxonomy_id": "tax_products"
          }
        ]
      },
      "source_blobs": [
        {}
      ],
      "internal_metadata": {},
      "metadata": {},
      "vector": [
        123
      ],
      "presigned_url": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

Headers

Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

collection_identifier
string
required

The ID of the collection to list documents from.

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request model for listing documents.

filters
object | null

Filters to apply. Represents a logical operation (AND, OR, NOT) on filter conditions.

Allows nesting with a defined depth limit.

sort
object | null

Sort options. Specifies how to sort query results.

Attributes: field: Field to sort by direction: Sort direction (ascending or descending)

Search term.

return_url
boolean | null
default:false

Whether to return presigned URLs for object keys.

return_vectors
boolean | null
default:false

Whether to return vector embeddings in the document results.

Response

Successful Response

Response model for listing documents.

results
DocumentResponse · object[]
required
pagination
object
required

PaginationResponse.