Index GDrive File | 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/file",
    headers=headers,
    json={
        "service_account_json": "<contents of the service-account key .json file, as a string>",
        "subject_email": "analyst@yourco.com",
        "file_id": "1AbC2dEf3GhI4jKl5MnO",
        "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 single Google Drive file (by file ID) into a collection (headless).

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.

file_idstringRequired

Google Drive file ID (the ‘/d/<id>/’ segment of a file URL). Native Google Docs/Sheets/Slides are exported to PDF/XLSX automatically.

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.

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.

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.

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 chunks from this file. 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

statusstringDefaults to pending

Errors

400

Bad Request Error

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

Path parameters

Headers

Request

Response

Errors