Index Dropbox | Captain Docs

Index all files from a Dropbox account into a collection.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID
Idempotency-Key: UUID for request deduplication (optional)

Args: collection_name: Name of the collection (path parameter) body: Dropbox access token

Returns: { job_id, status: “pending” }

Index all files from a Dropbox account into a collection. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID - Idempotency-Key: UUID for request deduplication (optional) Args: collection_name: Name of the collection (path parameter) body: Dropbox access token Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

dropbox_access_tokenstringRequired

Dropbox access token with files.metadata.read and files.content.read scopes. Generate one from the Dropbox App Console (Settings tab -> Generated access token). Tokens are short-lived and scoped to the token owner’s account, ideal for one-shot indexing jobs.

processing_typeenumRequired

Document processing type. ‘advanced’ uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. ‘basic’ provides reliable OCR optimized for general document indexing and high-volume processing.

custom_metadatamap from strings to strings or integers or doubles or booleans or lists of strings or nullOptional

Custom metadata to attach to all indexed chunks. Keys must be strings. Values: str, int, float, bool, or List[str].

max_filesinteger or nullOptional

overwrite_existingbooleanOptionalDefaults to false

When true, files that already exist in the collection will be deleted and re-indexed with the latest changes. Requires skip_existing=false. Setting both to true returns a 400 error.

parsing_scriptstring or nullOptional

Relative path to a JS parsing script for JSON files (e.g. ‘research/paper-parser’). When provided, .json files are processed through a sandboxed V8 isolate. Without this, .json files are indexed as raw text.

skip_existingbooleanOptionalDefaults to true

When true, files already indexed in the collection are skipped and will not be re-indexed with incoming changes. When false, all incoming files are indexed regardless of whether they already exist.

transcription_languagestring or nullOptional

AWS Transcribe language code for the spoken audio (e.g. ‘es-US’, ‘pt-BR’). Omit to auto-detect per file. Video and audio files only. Supported codes: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

Response

Successful Response

job_idstring

statusstringDefaults to pending

Errors

400

Bad Request Error

1	import requests
2
3	BASE_URL = "https://api.runcaptain.com"
4	API_KEY = "your_api_key"
5
6	headers = {
7	"Authorization": f"Bearer {API_KEY}",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(
12	f"{BASE_URL}/v2/collections/my_documents/index/dropbox",
13	headers=headers,
14	json={
15	"dropbox_access_token": "your_dropbox_access_token",
16	"processing_type": "advanced"
17	},
18	timeout=60.0
19	)
20
21	if response.status_code in [200, 201]:
22	data = response.json()
23	print(f"Job started! ID: {data['job_id']}")
24	else:
25	print(f"Error: {response.status_code}")

1	{
2	"job_id": "job_dropbox_abc123",
3	"status": "pending"
4	}