POST
/
v1
/
collections
/
{collection_identifier}
/
documents
Create a document.
curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_id": "collection_123",
  "source_details": [
    {
      "type": "bucket",
      "source_id": "<string>",
      "object_id": "<string>",
      "feature_extractor_task_id": "<string>",
      "object_task_id": "<string>",
      "source_blobs": [
        {
          "blob_id": "<string>",
          "property": "<string>",
          "key_prefix": "<string>",
          "type": "string",
          "data": "<string>",
          "metadata": {},
          "details": {
            "filename": "<string>",
            "size_bytes": 123,
            "mime_type": "<string>",
            "hash": "<string>",
            "s3_object_key": "<string>"
          }
        }
      ],
      "feature_extractor_id": "<string>",
      "batch_id": "<string>",
      "batch_task_id": "<string>"
    }
  ],
  "metadata": {},
  "features": [
    {
      "feature_extractor_id": "<string>",
      "payload": {},
      "vectors": {}
    }
  ]
}'
{
  "document_id": "<string>",
  "collection_id": "<string>",
  "source_details": [
    {
      "type": "bucket",
      "source_id": "<string>",
      "object_id": "<string>",
      "feature_extractor_task_id": "<string>",
      "object_task_id": "<string>",
      "source_blobs": [
        {
          "blob_id": "<string>",
          "property": "<string>",
          "key_prefix": "<string>",
          "type": "string",
          "data": "<string>",
          "metadata": {},
          "details": {
            "filename": "<string>",
            "size_bytes": 123,
            "mime_type": "<string>",
            "hash": "<string>",
            "s3_object_key": "<string>"
          }
        }
      ],
      "feature_extractor_id": "<string>",
      "batch_id": "<string>",
      "batch_task_id": "<string>"
    }
  ],
  "enrichments": {
    "clusters": [
      {
        "cluster_id": "cluster_001",
        "coordinates": [
          0.12,
          0.23,
          0.34,
          0.45,
          0.56
        ],
        "distance_to_centroid": 0.15,
        "document_id": "doc_123",
        "features": {
          "category": "electronics",
          "product_name": "Widget A"
        },
        "source_details": {
          "source_id": "col_products_v1",
          "type": "collection"
        }
      }
    ],
    "taxonomies": [
      {
        "label": "Mobile Phones",
        "node_id": "node_electronics_phones",
        "path": [
          "products",
          "electronics",
          "phones"
        ],
        "score": 0.87,
        "taxonomy_id": "tax_products"
      }
    ]
  },
  "source_blobs": [
    {}
  ],
  "internal_metadata": {},
  "metadata": {},
  "vector": [
    123
  ],
  "presigned_url": "<string>"
}

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

​
collection_identifier
string
required

The ID of the collection.

Body

application/json

Request model for creating a document.

Response

200
application/json

Successful Response

Response model for a single document.