Delete File | Captain API Documentation

Soft delete a specific file from a database.

This operation marks the file as deleted in the organization_files table (is_deleted=true, deleted_at=timestamp) without physically removing the data.

Headers:

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

Args: database_name: Name of the database containing the file file_id: File ID to delete

Returns: StandardResponse indicating success or failure

Soft delete a specific file from a database. This operation marks the file as deleted in the organization_files table (is_deleted=true, deleted_at=timestamp) without physically removing the data. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID Args: database_name: Name of the database containing the file file_id: File ID to delete Returns: StandardResponse indicating success or failure

Headers

AuthorizationstringRequired

Captain API key for authentication

X-Organization-IDstringRequired

Organization UUID

Request

This endpoint expects an object.

database_namestringRequired

file_idstringRequired

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/delete-file",
15	headers=headers,
16	data={
17	"database_name": "my_documents",
18	"file_id": "file_abc123"
19	},
20	timeout=30.0
21	)
22
23	if response.status_code == 200:
24	print("File deleted successfully!")
25	print(response.json())
26	else:
27	print(f"Error: {response.status_code}")
28	print(response.json())

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

Headers

Request

Response

Errors