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 or null

messagestring or null

documents_deletedinteger or null

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

1	{
2	"success": true,
3	"message": "All documents deleted from collection 'my_documents'",
4	"documents_deleted": 142
5	}