Bucket Objects
List Objects
Health
Collections
Collection Documents
Collection Features
Retriever Stages
Taxonomies
Clusters
Retriever Interactions
Namespaces
Research
Bucket Objects
List Objects
This endpoint lists objects in a bucket with pagination, sorting, and filtering options.
POST
/
v1
/
buckets
/
{bucket_identifier}
/
objects
curl --request POST \
--url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects \
--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>"
}'
{
"results": [
{
"blobs": [
{
"data": {
"num_pages": 5,
"title": "Service Agreement 2024"
},
"details": {
"filename": "agreement.pdf",
"hash": "sha256:a1b2c3d4e5f6...",
"mime_type": "application/pdf",
"s3_object_key": "tenant123/object456/content.pdf",
"size_bytes": 1245678
},
"key": "/contract-2024/content.pdf",
"metadata": {
"author": "John Doe",
"department": "Legal"
},
"property": "content",
"status": "COMPLETED",
"type": "PDF"
}
],
"bucket_id": "bkt_12345678",
"created_at": "2024-06-01T10:30:00Z",
"created_by": "user_12345",
"key": "/documents/contract-2024",
"metadata": {
"category": "contracts",
"status": "active",
"year": 2024
},
"object_id": "obj_a1b2c3d4e5f6",
"status": "COMPLETED",
"task_id": "task_87654321",
"updated_at": "2024-06-01T10:35:12Z"
}
],
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>"
}
}
Headers
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'
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
Identifier of the bucket
Body
application/json
Request model for listing objects in a bucket
Response
200
application/json
Successful Response
Response model for listing objects in a bucket
Was this page helpful?
curl --request POST \
--url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects \
--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>"
}'
{
"results": [
{
"blobs": [
{
"data": {
"num_pages": 5,
"title": "Service Agreement 2024"
},
"details": {
"filename": "agreement.pdf",
"hash": "sha256:a1b2c3d4e5f6...",
"mime_type": "application/pdf",
"s3_object_key": "tenant123/object456/content.pdf",
"size_bytes": 1245678
},
"key": "/contract-2024/content.pdf",
"metadata": {
"author": "John Doe",
"department": "Legal"
},
"property": "content",
"status": "COMPLETED",
"type": "PDF"
}
],
"bucket_id": "bkt_12345678",
"created_at": "2024-06-01T10:30:00Z",
"created_by": "user_12345",
"key": "/documents/contract-2024",
"metadata": {
"category": "contracts",
"status": "active",
"year": 2024
},
"object_id": "obj_a1b2c3d4e5f6",
"status": "COMPLETED",
"task_id": "task_87654321",
"updated_at": "2024-06-01T10:35:12Z"
}
],
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>"
}
}