Index File | Captain API Documentation

Index files from user’s S3 bucket into the database. Database ID is looked up automatically from organization_id + database_name.

Args: database_name: Name of the database (looked up automatically) aws_access_key_id: AWS access key for S3 bucket aws_secret_access_key: AWS secret key for S3 bucket bucket_name: S3 bucket name bucket_region: S3 bucket region organization_id: Organization UUID api_key: Captain API key for authentication

Index files from user's S3 bucket into the database. Database ID is looked up automatically from organization_id + database_name. Args: database_name: Name of the database (looked up automatically) aws_access_key_id: AWS access key for S3 bucket aws_secret_access_key: AWS secret key for S3 bucket bucket_name: S3 bucket name bucket_region: S3 bucket region organization_id: Organization UUID api_key: Captain API key for authentication

Headers

AuthorizationstringRequired

Captain API key for authentication

X-Organization-IDstringRequired

Organization UUID

Request

This endpoint expects an object.

database_namestringRequired

aws_access_key_idstringRequired

aws_secret_access_keystringRequired

bucket_namestringRequired

api_keystringRequired

organization_idstringRequired

bucket_regionstringOptionalDefaults to us-east-1

processing_tierstringOptionalDefaults to balanced

max_filesinteger or nullOptional

Response

Successful Response

successboolean

messagestring

database_file_idstring

statusstring

errorstring or null

job_idstring or null

1	curl -X POST https://api.runcaptain.com/v1/index \
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 "aws_access_key_id=AKIAIOSFODNN7EXAMPLE" \
7	-d "aws_secret_access_key=wJalrXUtnFEMI%2FK7MDENG%2FbPxRfiCYEXAMPLEKEY" \
8	-d "bucket_name=my-company-docs" \
9	-d "api_key=sk_captain_abc123" \
10	-d "organization_id=org_abc123" \
11	-d "bucket_region=us-east-1"

1	{
2	"success": true,
3	"message": "Indexing job started successfully",
4	"database_file_id": "string",
5	"status": "processing",
6	"job_id": "job_abc123",
7	"timestamp": "2024-01-15T10:30:00Z"
8	}

Headers

Request

Response

Errors