Create Backblaze Sync | Captain Docs

import requests
BASE_URL = "https://api.captain.dev"
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/backblaze",
    headers=headers,
    json={
        "bucket": "my-bucket",
        "prefix": "docs/",
        "endpoint_url": "https://s3.us-west-004.backblazeb2.com",
        "region": "us-west-004",
        "access_key_id": "your-key-id",
        "secret_access_key": "your-app-key",
        "processing_type": "advanced",
        "include_patterns": [
            "*.pdf",
            "*.docx"
        ],
        "exclude_patterns": [
            "drafts/*"
        ],
        "deletion_policy": "mirror",
        "custom_metadata": {
            "team": "research",
            "source": "backblaze"
        },
        "sync_interval_minutes": 15
    }
)
print(response.json())

{
  "sync_id": "sync_7e0abee6e110457db2c8",
  "collection_name": "company-knowledge",
  "bucket": "my-bucket",
  "prefix": "docs/",
  "region": "us-west-004",
  "auth_method": "access_key",
  "processing_type": "advanced",
  "include_patterns": [
    "*.pdf",
    "*.docx"
  ],
  "exclude_patterns": [
    "drafts/*"
  ],
  "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 Backblaze B2 Sync for a collection and start the initial backfill. Returns the sync; indexing runs asynchronously.

Path parameters

collection_namestringRequired

Destination collection.

Request

This endpoint expects an object.

bucketstringRequired

Backblaze B2 bucket to keep in sync with the collection.

endpoint_urlstringRequired

Backblaze B2 S3 endpoint, e.g. https://s3.REGION.backblazeb2.com

access_key_idstringRequired

Backblaze B2 Application Key ID (S3 access key ID).

secret_access_keystringRequired

Backblaze B2 Application Key (S3 secret). Stored securely, never returned.

processing_typeenumRequired

Parsing tier.

prefixstringOptionalDefaults to

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

regionstringOptionalDefaults to us-east-1

Region of the bucket (e.g. ‘us-west-004’), matching 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 objects removed from the source: mirror removes them from the collection so they no longer appear in search; archive keeps the document’s content but marks it archived, excluded from search by default and surfaced with include_archived: true; ignore leaves the indexed copy in place.

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. Returned by the list endpoint (GET /v2/syncs) only; other sync endpoints omit this field.

auth_methodenumOptional

How the sync authenticates to the bucket: ‘iam_role’ (AWS cross-account assume-role), ‘access_key’ (S3-compatible key pair), or ‘service_account’ (GCS service-account JSON).

account_namestring or nullOptional

Azure Blob syncs only: the storage account name. Null for other providers.

endpoint_urlstring or nullOptional

S3-compatible endpoint URL (access-key syncs on non-AWS providers); null for AWS S3. Returned by the list endpoint (GET /v2/syncs) only; other sync endpoints omit this field.

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

SNS subscribe URL; only surfaced by the subscribe-webhook 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