Index R2 Bucket | Captain Docs

Index all files from a Cloudflare R2 bucket into a collection. R2 is S3-compatible - provide your R2 API token’s Access Key ID and Secret Access Key. Returns a job_id for tracking progress via GET /v2/jobs/{job_id}.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

bucket_namestringRequired

Name of the R2 bucket

account_idstringRequired

Cloudflare account ID (found in your R2 dashboard URL)

access_key_idstringRequired

R2 S3 API token Access Key ID

secret_access_keystringRequired

R2 S3 API token Secret Access Key

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.

Allowed values:

jurisdictionenumOptionalDefaults to default

R2 jurisdiction. ‘default’ for global, ‘eu’ for EU-only storage, ‘fedramp’ for FedRAMP-compliant storage.

Allowed values:

max_filesintegerOptional

Maximum number of files to index (optional)

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.

custom_metadatamap from strings to anyOptional

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

parsing_scriptstringOptional

Relative path to a JavaScript parsing script for JSON files (e.g. ‘research/paper-parser’). When provided, .json files are processed through a sandboxed V8 isolate that executes the script to extract text and metadata. Without this parameter, .json files are indexed as raw text. Scripts are org-scoped and managed in the Parser Studio.

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.

Response

Indexing Job Started

job_idstring

statusenum

Allowed values:

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/r2",
13	headers=headers,
14	json={
15	"bucket_name": "my-r2-bucket",
16	"account_id": "your_cloudflare_account_id",
17	"access_key_id": "your_r2_access_key_id",
18	"secret_access_key": "your_r2_secret_access_key",
19	"processing_type": "advanced"
20	},
21	timeout=60.0
22	)
23
24	if response.status_code in [200, 201]:
25	data = response.json()
26	print(f"Job started! ID: {data['job_id']}")
27	else:
28	print(f"Error: {response.status_code}")

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

Authentication

Path parameters

Headers

Request

Response