Index S3 File | Captain Docs

Index a single file from an S3 bucket into a collection. Returns a job_id for tracking progress.

Path parameters

collection_namestringRequired

Name of the collection to index into

Request

This endpoint expects an object.

bucket_namestringRequired

Name of the S3 bucket

file_uristringRequired

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

aws_access_key_idstringRequired

AWS access key ID with read access to the bucket

aws_secret_access_keystringRequired

AWS secret access key

processing_typeenumRequired

Document processing type. ‘advanced’ uses agentic OCR with AI-enhanced extraction for complex layouts, tables, figures, charts, and documents containing images. ‘basic’ provides reliable OCR optimized for general document indexing and high-volume processing.

Allowed values:

bucket_regionstringOptionalDefaults to us-east-1

AWS region where the bucket is located

custom_metadatamap from strings to anyOptional

Custom metadata to attach to all chunks from this file. Keys must be strings. Values: str, int, float, bool, or array of strings.

Response

Indexing Job Started

job_idstring

statusenum

Allowed values:

1	curl -X POST https://api.runcaptain.com/v2/collections/my_documents/index/s3/file \
2	-H "Content-Type: application/json" \
3	-d '{
4	"bucket_name": "my-s3-bucket",
5	"file_uri": "s3://my-s3-bucket/contracts/acme_contract.pdf",
6	"aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
7	"aws_secret_access_key": "your_secret_key",
8	"processing_type": "advanced",
9	"bucket_region": "us-east-1"
10	}'

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

Path parameters

Headers

Request

Response