latestOpenAPI 3.1.02026-08-215721,1322.8 MB

1c7f31821424

Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics42

Annotations7

Apps34

Batches4

Bucket Batches23

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters10

Collection Documents17

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections13

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications13

Onboarding2

Organization API Keys5

Organization Audit4

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations4

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Learned Fusion10

Retriever Stages1

Retrievers14

Scaffold Templates3

Source Adapter1

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates24

Triggers10

Webhooks5

Collections

Import external documents into a collection

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

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 (BACKE-3367; 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[]