Index OneDrive Directory

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/onedrive/directory",
    headers=headers,
    json={
        "tenant_id": "00000000-1111-2222-3333-444444444444",
        "client_id": "your_entra_application_client_id",
        "client_secret": "your_entra_client_secret",
        "user_email": "analyst@yourco.com",
        "folder_id": "01ABCDEF2GHIJKL3MNOP",
        "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 OneDrive folder (recursively) into a collection (headless).

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

tenant_idstringRequired

Microsoft Entra ID tenant (directory) ID of the customer’s Microsoft 365 environment. A GUID, or the tenant domain (e.g. ‘contoso.onmicrosoft.com’).

client_idstringRequired

Application (client) ID of the Entra ID App Registration the customer’s admin created for Captain.

client_secretstringRequired

Client secret generated for that App Registration. Used once per job to mint app-only Microsoft Graph tokens; never stored.

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.

user_emailstringRequired

Email (user principal name) of the OneDrive for Business user whose drive to index. Requires the Files.Read.All application permission.

folder_idstringRequired

Graph driveItem ID of the folder to index. All files within it and its subfolders are indexed.

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’).

max_filesinteger or nullOptional

Response

Successful Response

job_idstring

statusstringOptionalDefaults to pending

Errors

400

Bad Request Error

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

Path parameters

Headers

Request

Response

Errors