Index R2 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/r2/file",
    headers=headers,
    json={
        "bucket_name": "my-r2-bucket",
        "file_uri": "r2://my-r2-bucket/reports/annual-review.pdf",
        "account_id": "your_cloudflare_account_id",
        "access_key_id": "your_r2_access_key_id",
        "secret_access_key": "your_r2_secret_access_key",
        "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 a Cloudflare R2 bucket into a collection.

Headers:

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

Args: collection_name: Name of the collection (path parameter) body: R2 file configuration with file_uri (r2://bucket/path/to/file.pdf)

Returns: { job_id, status: “pending” }

Index a single file from a Cloudflare R2 bucket into a collection. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID Args: collection_name: Name of the collection (path parameter) body: R2 file configuration with file_uri (r2://bucket/path/to/file.pdf) Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

access_key_idstringRequired

account_idstringRequired

bucket_namestringRequired

file_uristringRequired

R2 object URI in the format r2://bucket-name/path/to/file.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.

secret_access_keystringRequired

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].

jurisdictionenum or nullOptionalDefaults to default

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.

mask_piibooleanOptionalDefaults to false

When true, detected PII (emails, phone numbers, SSNs, credit cards, names, and locations) is masked in the parsed content before it is embedded and stored — replaced with entity tags like <PERSON> and <EMAIL_ADDRESS>. For images (including images embedded in PDFs), PII text visible in the image is also pixel-redacted. Opt-in; defaults to false, which leaves content unchanged.

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

statusstringOptionalDefaults to pending

Errors

400

Bad Request Error

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