Index S3 File | Captain Docs

1 import requests 2 3 BASE_URL = "https://api.runcaptain.com" 4 API_KEY = "your_api_key" 5 ORG_ID = "your_organization_id" 6 7 headers = { 8 "Authorization": f"Bearer {API_KEY}", 9 "X-Organization-ID": ORG_ID, 10 "Content-Type": "application/json" 11 } 12 13 response = requests.post( 14 f"{BASE_URL}/v2/collections/my_documents/index/s3/file", 15 headers=headers, 16 json={ 17 "bucket_name": "my-s3-bucket", 18 "file_uri": "s3://my-s3-bucket/contracts/acme_contract.pdf", 19 "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE", 20 "aws_secret_access_key": "your_secret_key", 21 "bucket_region": "us-east-1" 22 }, 23 timeout=60.0 24 ) 25 26 if response.status_code in [200, 201]: 27 result = response.json() 28 print(f"Job started! Job ID: {result.get('job_id')}") 29 else: 30 print(f"Error: {response.status_code}")

1 { 2 "job_id": "string", 3 "status": "pending" 4 }

Index a single file from an S3 bucket into a collection.

Headers:

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

Index a single file from an S3 bucket into a collection. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID

Path parameters

collection_namestringRequired

Name of the collection to index into

Request

This endpoint expects an object.

bucket_namestringRequired

file_uristringRequired

S3 URI format: s3://bucket-name/path/to/file.pdf

aws_access_key_idstringRequired

aws_secret_access_keystringRequired

bucket_regionstringOptionalDefaults to us-east-1

Response

Indexing Job Started

job_idstring

statusenum

Allowed values: