Skip to main content
PATCH
/
v1
/
buckets
/
{bucket_identifier}
/
objects
/
{object_identifier}
Partially Update Object
curl --request PATCH \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/{object_identifier} \
  --header 'Content-Type: application/json' \
  --data '
{
  "key_prefix": "<string>",
  "skip_duplicates": true
}
'
{
  "bucket_id": "<string>",
  "object_id": "<string>",
  "key_prefix": "<string>",
  "blobs": [
    {
      "property": "<string>",
      "type": "string",
      "blob_id": "<string>",
      "key_prefix": "/videos/video.mp4",
      "properties": {},
      "details": {
        "filename": "<string>",
        "size_bytes": 123,
        "mime_type": "<string>",
        "hash": "<string>"
      }
    }
  ],
  "source_details": [
    {
      "type": "bucket",
      "source_id": "<string>"
    }
  ],
  "status": "DRAFT",
  "error": "Failed to process object: Object not found",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

​
object_identifier
string
required

The unique identifier of the object.

Body

application/json

Request model for partially updating a bucket object (PATCH operation).

Task 10: Use extra='allow' to accept any user-defined fields at root level. No nested metadata dict - all fields are flat.

​
key_prefix
string | null

Updated storage key/path prefix of the object

​
skip_duplicates
boolean | null

Skip duplicate blobs

Response

Successful Response

Response model for bucket objects.

​
bucket_id
string
required

ID of the bucket this object belongs to

​
object_id
string

Unique identifier for the object

​
key_prefix
string | null

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.

​
blobs
BlobModel · object[]

List of blobs contained in this object

​
source_details
SourceDetails · object[]

Lineage/source details for this object; used for downstream references.

​
status
enum<string>
default:DRAFT

The current status of the object.

Available options:
PENDING,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
UNKNOWN,
SKIPPED,
DRAFT,
ACTIVE,
ARCHIVED,
SUSPENDED
​
error
string | null

The error message if the object failed to process.

Example:

"Failed to process object: Object not found"

​
created_at
string<date-time> | null

Timestamp when the object was created. Automatically populated by the system.

​
updated_at
string<date-time> | null

Timestamp when the object was last updated. Automatically populated by the system.