Wipe Documents

DELETE

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

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

collection_namestringRequired

Successful Response

messagestring

successboolean

document_idstring or null

documents_deletedinteger or null

1	import json
2	import requests
3	import uuid
4
5	BASE_URL = "https://api.runcaptain.com"
6	API_KEY = "your_api_key"
7	COLLECTION_NAME = "my_documents"
8
9	headers = {
10	"Authorization": f"Bearer {API_KEY}",
11	"Idempotency-Key": str(uuid.uuid4()),
12	}
13
14	response = requests.delete(
15	f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/documents",
16	headers=headers,
17	timeout=30.0
18	)
19
20	print(json.dumps(response.json(), indent=2))