Index Gcs Bucket | Captain API Documentation

Index all files from Google Cloud Storage 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: GCS bucket name containing files to index service_account_json: Service Account JSON credentials (as string)

Authentication: Requires valid API key in Authorization header

Index all files from Google Cloud Storage 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: GCS bucket name containing files to index service_account_json: Service Account JSON credentials (as string) 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

service_account_jsonstringRequired

processing_tierstringOptionalDefaults to balanced

max_filesinteger or nullOptional

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-gcs \
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 "service_account_json=%7B%22type%22%3A%22service_account%22%2C%22project_id%22%3A%22my-project%22%2C%22private_key_id%22%3A%22key123%22%2C%22private_key%22%3A%22-----BEGIN%20PRIVATE%20KEY-----%5Cn...%5Cn-----END%20PRIVATE%20KEY-----%5Cn%22%7D"

1	{
2	"success": true,
3	"message": "Indexing job started for GCS bucket 'my-company-docs'",
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_gcs_abc123xyz",
12	"timestamp": "2024-01-15T10:30:00Z"
13	}

Headers

Request

Response

Errors