Wipe Database | Captain API Documentation

Wipe all files from a database without deleting the database itself.

This operation soft deletes all files in the organization_files table for the specified database (is_deleted=true, deleted_at=timestamp). The database structure in captain_dbs remains active and intact.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID

This is useful for:

Clearing out old indexed content before re-indexing
Resetting a database to empty state
Removing specific dataset while keeping database configuration

Args: database_name: Name of the database to wipe files from

Returns: StandardResponse with count of files wiped

Wipe all files from a database without deleting the database itself. This operation soft deletes all files in the organization_files table for the specified database (is_deleted=true, deleted_at=timestamp). The database structure in captain_dbs remains active and intact. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID This is useful for: - Clearing out old indexed content before re-indexing - Resetting a database to empty state - Removing specific dataset while keeping database configuration Args: database_name: Name of the database to wipe files from Returns: StandardResponse with count of files wiped

Headers

AuthorizationstringRequired

Captain API key for authentication

X-Organization-IDstringRequired

Organization UUID

Request

This endpoint expects an object.

database_namestringRequired

Response

Successful Response

successboolean

messagestring

errorstring 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
7	headers = {
8	"Authorization": f"Bearer {API_KEY}",
9	"X-Organization-ID": ORG_ID,
10	"Content-Type": "application/x-www-form-urlencoded"
11	}
12
13	response = requests.post(
14	f"{BASE_URL}/v1/wipe-database",
15	headers=headers,
16	data={"database_name": "my_documents"},
17	timeout=30.0
18	)
19
20	if response.status_code == 200:
21	result = response.json()
22	print(f"Database wiped! Files deleted: {result.get('files_deleted', 0)}")
23	else:
24	print(f"Error: {response.status_code}")
25	print(response.json())

1	{
2	"success": true,
3	"message": "File deleted successfully"
4	}

Headers

Request

Response

Errors