Index S3 Bucket | Captain API Documentation

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/x-www-form-urlencoded" 12 } 13 14 # Start indexing job 15 response = requests.post( 16 f"{BASE_URL}/v1/index-s3", 17 headers=headers, 18 data={ 19 "database_name": "my_documents", 20 "bucket_name": "my-s3-bucket", 21 "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE", 22 "aws_secret_access_key": "your_secret_key", 23 "bucket_region": "us-east-1" 24 }, 25 timeout=60.0 26 ) 27 28 if response.status_code in [200, 201]: 29 result = response.json() 30 job_id = result.get("job_id") 31 print(f"Indexing started! Job ID: {job_id}") 32 33 # Poll for status 34 while True: 35 status_resp = requests.get( 36 f"{BASE_URL}/v1/index-status/{job_id}", 37 headers={"Authorization": f"Bearer {API_KEY}"}, 38 timeout=30.0 39 ) 40 status = status_resp.json() 41 print(f"Status: {status.get('progress_message')}") 42 43 if status.get("completed"): 44 print("Indexing complete!") 45 break 46 time.sleep(5) 47 else: 48 print(f"Error: {response.status_code}") 49 print(response.json())

1 { 2 "success": true, 3 "message": "Indexing job started successfully", 4 "status": "processing", 5 "total_files": 1, 6 "supported_files": 1, 7 "unsupported_files": 1, 8 "replaced_files": 1, 9 "database_name": "string", 10 "bucket_name": "string", 11 "job_id": "job_abc123xyz", 12 "timestamp": "2024-01-15T10:30:00Z" 13 }

Index all files from S3 bucket into a database. Database ID is looked up automatically from organization_id + database_name.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID

Args: database_name: Name of the database (looked up automatically) bucket_name: S3 bucket name containing files to index aws_access_key_id: AWS access key for S3 bucket aws_secret_access_key: AWS secret key for S3 bucket bucket_region: S3 bucket region

Authentication: Requires valid API key in Authorization header

Index all files from S3 bucket into a database. Database ID is looked up automatically from organization_id + database_name. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID Args: database_name: Name of the database (looked up automatically) bucket_name: S3 bucket name containing files to index aws_access_key_id: AWS access key for S3 bucket aws_secret_access_key: AWS secret key for S3 bucket bucket_region: S3 bucket region Authentication: Requires valid API key in Authorization header

Headers

AuthorizationstringRequired

Captain API key for authentication

X-Organization-IDstringRequired

Organization UUID

Request

This endpoint expects an object.

database_namestringRequired

bucket_namestringRequired

aws_access_key_idstringRequired

aws_secret_access_keystringRequired

bucket_regionstringOptionalDefaults to us-east-1

processing_tierstringOptionalDefaults to balanced

max_filesinteger or nullOptional

streamboolean or nullOptionalDefaults to false

Response

Successful Response

successboolean

messagestring

statusstring

total_filesinteger

supported_filesinteger

unsupported_filesinteger

replaced_filesinteger

database_namestring

bucket_namestring

errorstring or null

job_idstring or null

Headers

Request

Response

Errors