Index Dropbox File | Captain Docs

import requests
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}
response = requests.post(
    f"{BASE_URL}/v2/collections/my_documents/index/dropbox/file",
    headers=headers,
    json={
        "dropbox_access_token": "your_dropbox_access_token",
        "file_path": "/Reports/annual-review.pdf",
        "processing_type": "advanced"
    },
    timeout=60.0
)
if response.status_code in [200, 201]:
    data = response.json()
    print(f"Job started! ID: {data['job_id']}")
else:
    print(f"Error: {response.status_code}")

Index a single file from Dropbox 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 file configuration with file_path

Returns: { job_id, status: “pending” }

Index a single file from Dropbox 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 file configuration with file_path 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.

file_pathstringRequired

Path to a single file within the Dropbox account (e.g. ‘/Reports/annual-review.pdf’).

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 chunks from this file. Keys must be strings. Values: str, int, float, bool, or List[str].

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	{
2	"job_id": "job_dropboxfile_abc123",
3	"status": "pending"
4	}