Skip to main content
POST
/
v1
/
documents
/
batch-get
Batch get documents by IDs
curl --request POST \
  --url https://api.mixpeek.com/v1/documents/batch-get \
  --header 'Content-Type: application/json' \
  --data '
{
  "document_ids": [
    "<string>"
  ],
  "return_presigned_urls": false
}
'
{
  "documents": [
    {
      "document_id": "<string>",
      "collection_id": "<string>",
      "document_blobs": [
        {
          "field": "<string>",
          "url": "<string>",
          "role": "source",
          "type": "other",
          "filename": "segment_0.mp4",
          "size_bytes": 1048576,
          "content_type": "video/mp4",
          "checksum": "sha256:a1b2c3d4e5f6...",
          "created_at": "2023-11-07T05:31:56Z",
          "source_blob_id": "blob_abc123",
          "presigned_url": "<string>"
        }
      ],
      "_internal": {
        "collection_id": "col_articles",
        "created_at": "2025-10-31T10:00:00Z",
        "document_id": "doc_f8966ff29c",
        "internal_id": "org_abc123",
        "lineage": {
          "path": "bkt_content/col_articles",
          "root_bucket_id": "bkt_content",
          "root_object_id": "obj_article_001",
          "source_object_id": "obj_article_001",
          "source_type": "bucket"
        },
        "metadata": {
          "ingestion_status": "COMPLETED"
        },
        "modality": "text",
        "namespace_id": "ns_xyz789",
        "updated_at": "2025-10-31T10:00:00Z"
      },
      "_vectors": [
        "<string>"
      ]
    }
  ],
  "not_found": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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"

​
authorization
string
​
X-Namespace
string

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'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Body

application/json

Batch retrieve documents by their IDs.

​
document_ids
string[]
required

List of document IDs to retrieve.

Required array length: 1 - 1000 elements
​
return_presigned_urls
boolean
default:false

Generate presigned download URLs for document blobs.

Response

Successful Response

Response for batch document retrieval.

​
documents
DocumentResponse · object[]

Retrieved documents.

​
not_found
string[]

Document IDs that were not found.