BYO Documents

Upsert documents with BYO vectors

Changed on

Upsert documents with user-provided vectors directly into a namespace. This bypasses the collection/batch/extractor pipeline entirely. Documents go directly to the vector store. Maximum 1000 documents per call.

post/v1/namespaces/{namespace_id}/documents/upsert

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/namespaces/{namespace_id}/documents/upsert
  • Auth: HTTP bearer

Path parameters

namespace_idstring required

The namespace to upsert documents into.

Example:ns_abc123def456

Request body

collection_idstring nullable

Target collection. Documents are tagged with this collection_id so they appear in collection-scoped queries, list, and clustering. When omitted a namespace-level default collection is used.

Response

Successful Response

insertedinteger required

Number of documents upserted.

document_idsstring[] required

IDs of all upserted documents.

write_tokenstring nullable

Opaque token for read-your-writes consistency (only when requested).

dropped_payload_fieldsobject

document_id -> payload field names that were REMOVED before storage because they collide with reserved internal field names. Their values are not stored anywhere and are not readable back. Rename the field (e.g. 'source_type' -> 'my_source_type') or nest it under 'metadata' to keep the value. Empty when nothing was dropped.

unsearchable_document_idsstring[]

document_ids that were stored but carry no vector for the collection's declared index, so a retriever search will not return them until you provide a vector for that index or run the collection's extractor. The documents are readable by list and get; they are only absent from search. Empty when every document is searchable.

warningsstring[]

Advisories about this write that did not fail it: today, that the idempotency replay entry could not be stored, so a retry with the same idempotency_key would write again.

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b75474e978ffRevision changes
    • breaking

      the /// request property type changed from array to no type

    • info

      added subschema #1 subschema #2 to the /// request property anyOf list