Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics42

Annotations9

Apps34

Batches4

Bucket Batches23

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters10

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

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

Ops1

Organization API Keys5

Organization Audit5

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

Retrievers15

Scaffold Templates3

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates24

Triggers10

Webhooks5

Collections

Clone Collection

Clone a collection with optional modifications.

**Purpose:**
Creates a NEW collection (with new ID) based on an existing one. This is the
recommended way to iterate on collection designs when you need to modify core
configuration that PATCH doesn't allow (source, feature_extractor, field_passthrough).

**Clone vs PATCH vs Template:**
- **PATCH**: Update metadata only (enabled, metadata, taxonomy_applications)
- **Clone**: Copy and modify core configuration (source, feature_extractor)
- **Template**: Start from a pre-configured pattern (for new projects)

**Common Use Cases:**
- Change feature extractor configuration (model, parameters)
- Modify field_passthrough to include/exclude fields
- Switch to different source (bucket or collection)
- Test modifications before replacing production collection
- Create variants (e.g., different embedding models)

**How it works:**
1. Source collection is copied
2. You provide a new name (REQUIRED)
3. Optionally override any other fields
4. A new collection is created with a new ID
5. Original collection remains unchanged

post/v1/collections/{collection_identifier}/clone

Path parameters

collection_identifierstring required

Source collection ID or name to clone.

Request body

collection_namestring required

REQUIRED. Name for the cloned collection. Must be unique and different from the source collection.

descriptionstring nullable

OPTIONAL. Description override. If omitted, copies from source collection.

enabledboolean nullable

OPTIONAL. Override enabled status. If omitted, copies from source collection.

metadataobject nullable

OPTIONAL. Override metadata. If omitted, copies from source collection.

Example request

{
  "collection_name": "product_embeddings_backup",
  "example_desc": "Clone with just a new name (exact copy)"
}

Response

Successful Response

source_collection_idstring required

ID of the source collection that was cloned.

Example response

{
  "collection": {
    "collection_id": "col_a1b2c3d4e5",
    "collection_name": "article_embeddings",
    "description": "Simple text collection: News articles with text embeddings from bucket source",
    "enabled": true,
    "feature_extractor": {
      "feature_extractor_name": "text_extractor",
      "field_passthrough": [
        {
          "source_path": "title"
        }
      ],
      "input_mappings": {
        "text": "content"
      },
      "version": "v1"
    },
    "input_schema": {
      "properties": {
        "title": {
          "type": "string"
        },
        "content": {
          "type": "text"
        }
      }
    },
    "output_schema": {
      "properties": {
        "title": {
          "type": "string"
        },
        "text_extractor_v1_embedding": {
          "type": "array"
        }
      }
    },
    "source": {
      "bucket_id": "bkt_articles",
      "type": "bucket"
    }
  }
}

Changes

Changed in 6 of the 34 revisions of this API.23832

Aug 27, 20267dc0581791b225See the full diff
- ▲
  response property collection/feature_extractor/parameters/anyOf[subschema #6: MultimodalExtractorParams]/transcription_language list-of-types was widened by adding types null to media type application/json of response 201
  response-property-list-of-types-widened
- ▲
  response property collection/source_lineage/items/feature_extractor/parameters/anyOf[subschema #6: MultimodalExtractorParams]/transcription_language list-of-types was widened by adding types null to media type application/json of response 201
  response-property-list-of-types-widened
- ○
  the request property default value en was removed
  request-property-default-value-removed
- ○
  request property //// list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  the response's property default value en was removed for the status
  response-property-default-value-removed
- ○
  the response's property default value en was removed for the status
  response-property-default-value-removed
Aug 27, 2026b8d3cdf035a04See the full diff
- ○
  added to the // request property anyOf list
  request-property-any-of-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added to the //// response property anyOf list for the response status
  response-property-any-of-added
Aug 26, 2026a712e239102b3See the full diff
- ○
  added the new optional request property //
  new-optional-request-property
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Aug 21, 20261c7f3182142421See the full diff
- ●
  added the new signals enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new signals enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  added the new signals enum value to the request property //
  request-property-enum-value-added
Aug 9, 20265d4c905106b41See the full diff
- ○
  the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API
  api-security-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 26, 20267cb0515333113618See the full diff
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_bounding_box enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_polygon enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property //////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property /////////
  request-property-enum-value-added
- ○
  added the new geo_radius enum value to the request property /////////
  request-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history