Skip to main content
GET
/
v1
/
buckets
/
{bucket_identifier}
/
objects
/
{object_identifier}
Get Object
curl --request GET \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/{object_identifier} \
  --header 'Authorization: Bearer <token>'
{
  "bucket_id": "<string>",
  "object_id": "<string>",
  "key_prefix": "<string>",
  "blobs": [
    {
      "property": "<string>",
      "blob_id": "<string>",
      "key_prefix": "/videos/video.mp4",
      "properties": {},
      "presigned_url": "<string>",
      "details": {
        "filename": "<string>",
        "size_bytes": 123,
        "mime_type": "<string>",
        "hash": "<string>"
      }
    }
  ],
  "source_details": [
    {
      "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",
  "document_count": 123,
  "consistency": {
    "retriever_visible": "<string>",
    "recommended_header": "<string>",
    "write_token_available": false,
    "expected_visible_within_ms": 123,
    "poll": {},
    "next_actions": [
      {}
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

​
object_identifier
string
required

The unique identifier of the object.

Query Parameters

​
return_presigned_urls
boolean
default:false

Generate fresh presigned download URLs for all blobs with S3 storage

​
include_document_count
boolean
default:true

Compute document_count via vector-store lineage (default true). Pass false to skip the vector fan-out for latency-sensitive views that don't render the count.

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,
QUEUED,
IN_PROGRESS,
PROCESSING,
COMPLETED,
COMPLETED_WITH_ERRORS,
FAILED,
CANCELED,
INTERRUPTED,
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.

​
document_count
integer | null

Number of documents produced from this object across all collections. Populated on GET requests. Null on list responses (expensive query). Use this to check if an object has already been processed.

​
consistency
WriteConsistency · object | null

When and how this object becomes a searchable document. Set on write (create) responses: managed ingestion is visible only after a collection batch processes the object — poll until document_count > 0.