Index S3 File
Index a single file from S3 bucket into a database.
Uses the same Step Function workflow as /index-s3 but targets a specific file.
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 the file
file_uri: S3 URI of the file (format: s3://bucket-name/path/to/file.pdf)
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
Authorization
Captain API key for authentication
X-Organization-ID
Organization UUID
Request
This endpoint expects an object.
database_name
bucket_name
file_uri
aws_access_key_id
aws_secret_access_key
bucket_region
processing_tier
Response
Successful Response
success
message
status
total_files
supported_files
unsupported_files
replaced_files
database_name
bucket_name
error
job_id