MImixpeek
Collections

Import external documents into a collection

Changed on

Reconstruct documents (with vectors + lineage) from one external export using a validated mapping, and write them into the collection via the BYO write core. Use /import/infer and /import/validate-mapping first; dry_run reconstructs and validates without writing.

post/v1/collections/{collection_identifier}/import

Request

  • Base URL
    https://api.mixpeek.com
  • Auth
    HTTP bearer and API key in header X-Namespace

Path parameters

collection_identifierstring required

The ID or name of the collection to import into

Request body

exportobject

One export object (e.g. an asset with its scene arrays).

dry_runboolean

Reconstruct and validate only; write nothing.

seed_ledgerboolean

Seed the ledger for heal-skip (no-op until available).

Response

Successful Response

importedinteger

Documents written (0 on dry_run).

reconstructedinteger

Documents reconstructed from the export.

skippedinteger

Rows that failed reconstruction.

dry_runboolean
warningsstring[]

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

  • 1c7f31821424Revision changes
    • info

      endpoint added