Index S3 Bucket | Captain API Documentation

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

1	curl -X POST https://api.runcaptain.com/v1/index-s3 \
2	-H "Authorization: Bearer YOUR_API_KEY" \
3	-H "X-Organization-ID: YOUR_ORG_UUID" \
4	-H "Content-Type: application/x-www-form-urlencoded" \
5	-d "database_name=contracts_2024" \
6	-d "bucket_name=my-company-docs" \
7	-d "aws_access_key_id=AKIAIOSFODNN7EXAMPLE" \
8	-d "aws_secret_access_key=wJalrXUtnFEMI%2FK7MDENG%2FbPxRfiCYEXAMPLEKEY" \
9	-d "bucket_region=us-east-1"

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	}

Headers

Request

Response

Errors