Index Supabase 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/supabase/file",
    headers=headers,
    json={
        "bucket_name": "documents",
        "file_uri": "documents/reports/annual-review.pdf",
        "endpoint_url": "https://abcdefgh.storage.supabase.co/storage/v1/s3",
        "access_key_id": "your_supabase_access_key",
        "secret_access_key": "your_supabase_secret_key",
        "region": "us-east-1",
        "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 Supabase Storage 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: Supabase file configuration with file_uri (object path within the bucket, e.g. reports/annual-review.pdf)

Returns: { job_id, status: “pending” }

Index a single file from a Supabase Storage 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: Supabase file configuration with file_uri (object path within the bucket, e.g. reports/annual-review.pdf) Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

access_key_idstringRequired

Supabase S3 access key ID (Storage → S3 Connection → access key).

bucket_namestringRequired

endpoint_urlstringRequired

S3-compatible endpoint URL for your Supabase project’s Storage S3 connection, e.g. https://<project_ref>.storage.supabase.co/storage/v1/s3 (Storage → S3 Connection). Required.

file_uristringRequired

Path to the object within the bucket, 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.

secret_access_keystringRequired

Supabase S3 secret access key (shown once when the S3 access key is created).

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.

regionstringOptionalDefaults to us-east-1

Region configured for your Supabase project’s S3 endpoint (Storage → S3 Connection). Required by the S3 protocol; defaults to ‘us-east-1’.

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_supabasefile_abc123",
3	"status": "pending"
4	}