Change Collection Environment

Move a collection from one environment to another (e.g., development to production) without reindexing.

All files, indexed data, and vector embeddings are preserved. The collection’s internal ID stays the same — only the environment label changes.

Use Cases

Promote a development collection to production after testing
Move a production collection back to staging for debugging
Reorganize collections across environments

Error Cases

400: Collection is already in the target environment
404: Collection not found in current environment
409: A collection with the same name already exists in the target environment

Move a collection from one environment to another (e.g., development to production) without reindexing. All files, indexed data, and vector embeddings are preserved. The collection's internal ID stays the same — only the environment label changes. ## Use Cases - Promote a development collection to production after testing - Move a production collection back to staging for debugging - Reorganize collections across environments ## Error Cases - **400**: Collection is already in the target environment - **404**: Collection not found in current environment - **409**: A collection with the same name already exists in the target environment

Path parameters

collection_namestringRequired

Name of the collection to move

Request

This endpoint expects an object.

new_environmentenumRequired

The target environment to move the collection to

Allowed values:

Response

Environment Changed Successfully

successboolean

Whether the environment change was successful

messagestring

Human-readable status message

collection_namestring

Name of the collection that was moved

previous_environmentstring

The environment the collection was moved from

new_environmentstring

The environment the collection was moved to

files_movedinteger

Number of files associated with the collection (all preserved)

1	const BASE_URL = "https://api.runcaptain.com";
2	const COLLECTION_NAME = "my_documents";
3
4	const response = await fetch(
5	`${BASE_URL}/v2/collections/${COLLECTION_NAME}/environment`,
6	{
7	method: "PATCH",
8	headers: {
9	"Authorization": `Bearer ${API_KEY}`,
10	"X-Organization-ID": ORG_ID,
11	"Content-Type": "application/json"
12	},
13	body: JSON.stringify({ new_environment: "production" })
14	}
15	);
16
17	const result = await response.json();
18	if (response.ok) {
19	console.log(`Moved from ${result.previous_environment} to ${result.new_environment}`);
20	console.log(`Files preserved: ${result.files_moved}`);
21	} else if (response.status === 409) {
22	console.log(`Conflict: ${result.detail \|\| 'Name already exists in target environment'}`);
23	} else {
24	console.log(`Error ${response.status}:`, result);
25	}

1	{
2	"success": true,
3	"message": "Collection environment changed successfully",
4	"collection_name": "my_documents",
5	"previous_environment": "development",
6	"new_environment": "production",
7	"files_moved": 42
8	}

Change Collection Environment

Use Cases

Error Cases

Path parameters

Headers

Request

Response

Errors

Use Cases

Error Cases