Index Gcs Directory | Captain Docs

Index all files from a specific directory in a GCS bucket.

Headers:

Authorization: Bearer {api_key} - Captain API key for authentication
X-Organization-ID: Organization UUID
Idempotency-Key: UUID for request deduplication (optional)

Args: collection_name: Name of the collection (path parameter) body: GCS directory configuration with directory_path

Returns: { job_id, status: “pending” }

Index all files from a specific directory in a GCS bucket. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID - Idempotency-Key: UUID for request deduplication (optional) Args: collection_name: Name of the collection (path parameter) body: GCS directory configuration with directory_path Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

bucket_namestringRequired

directory_pathstringRequired

Path to the directory within the bucket. Accepts either a relative path (e.g., ‘reports/2024/january’) or a full GCS URI (e.g., ‘gs://my-bucket/reports/2024/january’). All files within this directory and its subdirectories will be indexed.

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:

service_account_jsonstringRequired

custom_metadatamap from strings to optional strings or integers or doubles or booleans or lists of stringsOptional

Custom metadata to attach to all indexed chunks. Keys must be strings. Values: str, int, float, bool, or List[str].

max_filesintegerOptional

overwrite_existingbooleanOptionalDefaults to false

When true, files that already exist in the collection will be deleted and re-indexed with the latest changes. Requires skip_existing=false. Setting both to true returns a 400 error.

parsing_scriptstringOptional

Relative path to a JS parsing script for JSON files (e.g. ‘research/paper-parser’). When provided, .json files are processed through a sandboxed V8 isolate. Without this, .json files are indexed as raw text.

skip_existingbooleanOptionalDefaults to true

When true, files already indexed in the collection are skipped and will not be re-indexed with incoming changes. When false, all incoming files are indexed regardless of whether they already exist.

Response

Successful Response

job_idstring

statusstringDefaults to pending

Errors

400

Index Gcs Directory V2request Bad Request Error

1	import requests
2
3	url = "https://host.com/v2/collections/collection_name/index/gcs/directory"
4
5	payload = {
6	"bucket_name": "bucket_name",
7	"directory_path": "directory_path",
8	"processing_type": "advanced",
9	"service_account_json": "service_account_json"
10	}
11	headers = {"Content-Type": "application/json"}
12
13	response = requests.post(url, json=payload, headers=headers)
14
15	print(response.json())

1	{
2	"job_id": "job_id",
3	"status": "status"
4	}