Index GDrive | Captain Docs

import requests
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}
response = requests.post(
    f"{BASE_URL}/v2/collections/my_documents/index/gdrive",
    headers=headers,
    json={
        "service_account_json": "<contents of the service-account key .json file, as a string>",
        "subject_email": "analyst@yourco.com",
        "processing_type": "advanced"
    },
    timeout=60.0
)
if response.status_code in [200, 201]:
    data = response.json()
    print(f"Job started! ID: {data['job_id']}")
else:
    print(f"Error: {response.status_code}")

Index a Workspace user’s entire Google Drive into a collection (headless).

Uses service-account domain-wide delegation to read as subject_email — no per-user OAuth. Scope to a folder or single file with the /directory or /file variants.

Headers:

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

Returns: { job_id, status: “pending” }

Index a Workspace user's entire Google Drive into a collection (headless). Uses service-account domain-wide delegation to read as `subject_email` — no per-user OAuth. Scope to a folder or single file with the /directory or /file variants. Headers: - Authorization: Bearer {api_key} - X-Organization-ID: Organization UUID - Idempotency-Key: UUID for request deduplication (optional) Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

service_account_jsonstringRequired

Google Cloud service-account JSON (as a string). Its OAuth client ID must be authorized for the drive.readonly scope in the customer’s Workspace Domain-wide Delegation settings.

subject_emailstringRequired

Email of the Workspace user to impersonate. Must belong to the domain that authorized the service account. Drive content is read as this user.

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.

max_filesinteger or nullOptional

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.

mask_piibooleanOptionalDefaults to false

When true, detected PII (emails, phone numbers, SSNs, credit cards, names, and locations) is masked in the parsed content before it is embedded and stored — replaced with entity tags like <PERSON> and <EMAIL_ADDRESS>. For images (including images embedded in PDFs), PII text visible in the image is also pixel-redacted. Opt-in; defaults to false, which leaves content unchanged.

overwrite_existingbooleanOptionalDefaults to false

When true, files that already exist in the collection are re-indexed and replaced with zero downtime: the new version is built alongside the live one and atomically swapped in when complete, so the previous version keeps serving search results throughout the rebuild. The document keeps the same document_id across overwrites, and its status reads ‘updating’ in the document listing while the rebuild runs. Requires skip_existing=false. Setting both to true returns a 400 error.

transcription_languagestring or nullOptional

AWS Transcribe language code for the spoken audio (e.g. ‘es-US’, ‘pt-BR’). Omit to auto-detect per file. Video and audio files only. Supported codes: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html

custom_metadatamap from strings to strings or integers or doubles or booleans or lists of strings or nullOptional

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

parsing_scriptstring or nullOptional

Relative path to a JS parsing script for JSON files (e.g. ‘research/paper-parser’).

Response

Successful Response

job_idstring

statusstringOptionalDefaults to pending

Errors

400

Bad Request Error

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