Create R2 Sync | 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/company-knowledge/sync/r2",
    headers=headers,
    json={
        "bucket": "my-bucket",
        "prefix": "docs/",
        "account_id": "your-account-id",
        "access_key_id": "your-r2-key-id",
        "secret_access_key": "your-r2-secret",
        "jurisdiction": "default",
        "processing_type": "advanced",
        "include_patterns": [
            "*.pdf",
            "*.docx"
        ],
        "exclude_patterns": [
            "drafts/*"
        ],
        "deletion_policy": "mirror",
        "custom_metadata": {
            "team": "research",
            "source": "r2"
        },
        "sync_interval_minutes": 15
    }
)
print(response.json())

{
  "sync_id": "sync_7e0abee6e110457db2c8",
  "collection_name": "company-knowledge",
  "bucket": "my-company-docs",
  "prefix": "knowledge-base/",
  "region": "auto",
  "storage_type": "r2",
  "auth_method": "access_key",
  "processing_type": "advanced",
  "include_patterns": [],
  "exclude_patterns": [],
  "deletion_policy": "mirror",
  "status": "active",
  "secret_set": false,
  "sns_subscribe_url": null,
  "last_backfill_job_id": "91f2aa031d8f4e7d8877c4564eb486bd-1786120498",
  "last_reconcile_at": null,
  "sync_interval_minutes": 15,
  "next_sync_at": 1786120589056,
  "sync_state": "idle",
  "last_sync_at": null,
  "last_sync_error": null,
  "created_at": "2026-08-07T16:34:58.188233+00:00",
  "updated_at": "2026-08-07T16:34:58.612676+00:00"
}

Create a Cloudflare R2 Sync for a collection and start the initial backfill. The endpoint is derived from account_id and jurisdiction. Returns the sync; indexing runs asynchronously.

Path parameters

collection_namestringRequired

Destination collection.

Request

This endpoint expects an object.

bucketstringRequired

Cloudflare R2 bucket to keep in sync with the collection.

account_idstringRequired

Cloudflare account ID (from the R2 dashboard URL). Determines the endpoint.

access_key_idstringRequired

R2 S3 API token access key ID.

secret_access_keystringRequired

R2 S3 API token secret access key. Stored securely, never returned.

processing_typeenumRequired

Parsing tier.

prefixstringOptionalDefaults to

Key prefix to scope the sync. Empty syncs the whole bucket.

jurisdictionenumOptionalDefaults to default

R2 jurisdiction; selects the endpoint.

include_patternslist of stringsOptional

Glob patterns; only matching keys are synced.

exclude_patternslist of stringsOptional

Glob patterns; matching keys are excluded.

deletion_policyenumOptionalDefaults to mirror

How to propagate deletes.

custom_metadatamap from strings to anyOptional

Static metadata applied to every synced document.

sync_interval_minutesinteger or nullOptional

Scheduled reconcile cadence (minimum 5; null = manual).

Response

Successful Response

sync_idstringOptional

collection_namestringOptional

bucketstringOptional

prefixstringOptional

regionstringOptional

storage_typeenumOptional

The sync's cloud storage type.

auth_methodenumOptional

‘iam_role’ for assume-role syncs, ‘access_key’ for access-key syncs.

endpoint_urlstring or nullOptional

S3-compatible endpoint URL (access-key syncs on non-AWS providers); null for AWS S3.

processing_typeenumOptional

include_patternslist of stringsOptional

exclude_patternslist of stringsOptional

deletion_policyenumOptional

statusenumOptional

secret_setbooleanOptional

True once an event-webhook secret has been minted.

sns_subscribe_urlstring or nullOptional

Event-webhook subscribe URL (only surfaced by the webhooks endpoint).

last_backfill_job_idstring or nullOptional

last_reconcile_atstring or nullOptional

sync_interval_minutesinteger or nullOptional

Effective (already-clamped) cadence; null = manual.

next_sync_atinteger or nullOptional

Epoch ms of the next due scheduled reconcile.

sync_stateenum or nullOptional

last_sync_atinteger or nullOptional

last_sync_errorstring or nullOptional

created_atstringOptional

updated_atstring or nullOptional

Path parameters

Headers

Request

Response