GET
/
v1
/
buckets
/
{bucket_identifier}
/
objects
/
{object_identifier}
curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/{object_identifier}
{
  "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"
}

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

​
bucket_identifier
string
required

Identifier of the bucket

​
object_identifier
string
required

Identifier of the object

Response

200
application/json
Successful Response

Response model for bucket objects

​
object_id
string
required

Unique identifier for the object

​
bucket_id
string
required

ID of the bucket this object belongs to

​
blobs
object[]
required

List of blobs contained in this object

Model for a blob within a bucket object

​
status
enum<string>
required

Status of the object (PENDING, PROCESSING, COMPLETED, FAILED)

Available options:
DONE,
FAILED,
SKIPPED,
CANCELLED,
PROCESSING,
DOWNLOADING,
INITIALIZING,
UPLOADING,
QUEUED,
PENDING,
CONVERTING
​
metadata
object
required

Additional metadata for the object, appended to downstream documents of connected collections

​
task_id
string | null

ID of the task that created this object, used to track the object creation progress and status

​
key
string | null

Storage key/path of the object, used to retrieve the object from storage

​
created_by
string | null

Identifier of the entity that created this object

​
error
string | null

Error message if the object processing failed

​
created_at
string | null

Timestamp when the object was created

​
updated_at
string | null

Timestamp when the object was last updated

Was this page helpful?

Suggest editsRaise issue