Index S3 Bucket | Captain Docs

1 import requests 2 import time 3 4 BASE_URL = "https://api.runcaptain.com" 5 API_KEY = "your_api_key" 6 ORG_ID = "your_organization_id" 7 8 headers = { 9 "Authorization": f"Bearer {API_KEY}", 10 "X-Organization-ID": ORG_ID, 11 "Content-Type": "application/json" 12 } 13 14 # Start indexing job 15 response = requests.post( 16 f"{BASE_URL}/v2/collections/my_documents/index/s3", 17 headers=headers, 18 json={ 19 "bucket_name": "my-s3-bucket", 20 "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE", 21 "aws_secret_access_key": "your_secret_key", 22 "bucket_region": "us-east-1" 23 }, 24 timeout=60.0 25 ) 26 27 if response.status_code in [200, 201]: 28 result = response.json() 29 job_id = result.get("job_id") 30 print(f"Indexing started! Job ID: {job_id}") 31 32 # Poll for status using v2 jobs endpoint 33 while True: 34 status_resp = requests.get( 35 f"{BASE_URL}/v2/jobs/{job_id}", 36 headers={"Authorization": f"Bearer {API_KEY}"}, 37 timeout=30.0 38 ) 39 status = status_resp.json() 40 print(f"Status: {status.get('progress_message')}") 41 42 if status.get('status') in ['completed', 'failed', 'cancelled']: 43 print(f"Job {status.get('status')}!") 44 break 45 time.sleep(5) 46 else: 47 print(f"Error: {response.status_code}") 48 print(response.json())

1 { 2 "job_id": "abc123xyz-1234567890", 3 "status": "pending" 4 }

Index all files from an S3 bucket into a collection.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID
Idempotency-Key: UUID for request deduplication (optional)

Returns a job_id for tracking the indexing progress.

Index all files from an S3 bucket into a collection. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID - Idempotency-Key: UUID for request deduplication (optional) Returns a job_id for tracking the indexing progress.

Path parameters

collection_namestringRequired

Name of the collection to index into

Request

This endpoint expects an object.

bucket_namestringRequired

aws_access_key_idstringRequired

aws_secret_access_keystringRequired

bucket_regionstringOptionalDefaults to us-east-1

max_filesintegerOptional

Response

Indexing Job Started

job_idstring

statusenum

Allowed values: