Wipe Collection Documents

DELETE

https://api.runcaptain.com/v2/collections/:collection_name/documents

Remove all documents from a collection while keeping the collection structure.

AuthorizationBearer

Bearer token authentication using API key

collection_namestringRequired

Documents Wiped

successboolean

messagestring

documents_deletedinteger

1	import requests
2
3	BASE_URL = "https://api.runcaptain.com"
4	API_KEY = "your_api_key"
5	COLLECTION_NAME = "my_documents"
6
7	headers = {
8	"Authorization": f"Bearer {API_KEY}",
9	}
10
11	response = requests.delete(
12	f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/documents",
13	headers=headers,
14	timeout=120.0
15	)
16
17	if response.status_code == 200:
18	data = response.json()
19	print(f"Wiped {data.get('documents_deleted', 0)} documents")
20	else:
21	print(f"Error: {response.status_code}")

1	{
2	"success": true,
3	"message": "All documents have been successfully removed from the collection 'customer_profiles'.",
4	"documents_deleted": 1250
5	}