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
The unique identifier of the bucket.
Body
Request model for creating a bucket object.
Storage key/path prefix of the object, this will be used to retrieve the object from the storage. It's at the root of the object.
"/contract-2024"
List of blobs to be created in this object
[
{
"data": {
"num_pages": 5,
"title": "Service Agreement 2024"
},
"key_prefix": "/content.pdf",
"metadata": {
"author": "John Doe",
"department": "Legal"
},
"property": "content",
"type": "PDF"
}
]
Additional metadata for the object, this will be appended in all downstream documents of the your connected collections.
{
"category": "contracts",
"status": "draft",
"year": 2024
}
Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped.
Response
Successful Response
Response model for bucket objects.
ID of the bucket this object belongs to
Unique identifier for the object
Storage key/path of the object, this will be used to retrieve the object from the storage. It is similar to a file path. If not provided, it will be placed in the root of the bucket.
SHA256 hash of the object's content, used for de-duplication.
List of blobs contained in this object
Additional metadata for the object, this will be appended in all downstream documents of the your connected collections.
The current status of the object.
PENDING
, IN_PROGRESS
, PROCESSING
, COMPLETED
, FAILED
, CANCELED
, UNKNOWN
, SKIPPED
, DRAFT
The error message if the object failed to process.
"Failed to process object: Object not found"
Skip duplicate blobs, if a blob with the same hash already exists, it will be skipped.