stores

Copy a store

Copy a store into a new store with the given name.

The copy keeps every file, its metadata and its indexed chunks, without re-parsing or re-embedding anything. It runs in the background: both stores report the progress in copy_state, and the new store's status is in_progress until the copy completes. Neither store accepts file changes while the copy runs, and the source must have no files still being processed.

Args: store_identifier: The ID or name of the store to copy. params: The name of the copy and optional description and metadata overrides.

Returns: Store: The new store.

post/v1/stores/{store_identifier}/copy

Path parameters

string required

string uuid required

The ID or name of the store to copy

Request body

namestring required

Name for the copy. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).

descriptionstring nullable

Description of the copy; defaults to the source store's description

{"stackTrail":"components:schemas:StoreCopyParams:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Metadata for the copy; defaults to the source store's metadata","nullable":true}

tagsstring[] nullable

Tags for the copy; defaults to the source store's tags

Example request

{
  "name": "technical-documentation-copy"
}

Response

The new store; its contents arrive in the background

idstring required

Unique identifier for the store

namestring required

Name of the store

descriptionstring nullable

Detailed description of the store's purpose and contents

is_publicboolean

Whether the store can be accessed by anyone with valid login credentials

licensestring nullable

License for public stores

{"stackTrail":"components:schemas:Store:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Additional metadata associated with the store","example":{"category":"support","language":"en"},"nullable":true}

tagsstring[]

Tags for organizing stores

bucket_idstring nullable

Customer bucket backing this store's storage; null = platform default

status'expired' | 'in_progress' | 'completed' | 'failed'

Status of a store.

created_atstring date-time required

Timestamp when the store was created

updated_atstring date-time required

Timestamp when the store was last updated

last_active_atstring date-time nullable

Timestamp when the store was last used

usage_bytesinteger

Total storage usage in bytes

usage_tokensinteger

Total storage usage in tokens

expires_atstring date-time nullable

Optional expiration timestamp for the store

object'store'

Type of the object

Example response

{
  "id": "1b8b486e-16d0-400b-8868-04cd75217a7e",
  "name": "customer-support-kb",
  "description": "Contains customer support articles and FAQs",
  "metadata": {
    "category": "support",
    "language": "en"
  },
  "tags": [
    "production",
    "docs"
  ],
  "file_counts": {
    "pending": 5,
    "in_progress": 5,
    "cancelled": 2,
    "completed": 42,
    "failed": 1,
    "total": 50
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "usage_bytes": 1024000,
  "usage_tokens": 1024000,
  "expires_at": "2024-01-01T00:00:00Z"
}

Changes

Changed in 2 of the 30 revisions of this API.3

Sep 16, 2026bc159968f2112See 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
Sep 15, 2026957bf8ec8df81See the full diff
- ○
  endpoint added
  endpoint-added

Full history