---
title: "Index GDrive"
method: POST
path: "/v2/collections/{collection_name}/index/gdrive"
tags: ["indexing"]
---

# Index GDrive

`POST /v2/collections/{collection_name}/index/gdrive`

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_name` string, required

## Headers

- `authorization` string, nullable

## Request body

- IndexGDriveRequest
  - `service_account_json` string, required — 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_email` string, required — 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_type` 'advanced' | 'basic', required — 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_files` integer, nullable
  - `skip_existing` boolean — 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_pii` boolean — 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_existing` boolean — 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_language` string, nullable — 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_metadata` object, nullable — Custom metadata to attach to all indexed chunks. Keys must be strings. Values: str, int, float, bool, or List[str].
  - `parsing_script` string, nullable — Relative path to a JS parsing script for JSON files (e.g. 'research/paper-parser').

## Response `200`

Successful Response

- IndexJobResponse
  - `job_id` string, required
  - `status` string
  - `custom_metadata` object, nullable — The custom_metadata Captain accepted for this job, echoed back as validated. Null when none was supplied.

## Other responses

- `400` — overwrite_existing and skip_existing cannot both be true

---

[API](https://skmtc.dev/runcaptain/apis/api-reference.md) · [All operations](https://skmtc.dev/runcaptain/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runcaptain/api-reference/revisions/fe4649e3f4aa/schema)