Sign in
indexing

Index OneDrive

Index a user's entire OneDrive for Business into a collection (headless).

Uses Microsoft Graph app-only auth (Entra ID App Registration with the Files.Read.All application permission) — 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" }

post/v2/collections/{collection_name}/index/onedrive

Path parameters

collection_namestring required

Headers

authorizationstring nullable

Request body

tenant_idstring required

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_idstring required

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

client_secretstring required

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

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.

skip_existingboolean

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_piiboolean

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_existingboolean

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 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_metadataobject nullable

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

parsing_scriptstring nullable

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

user_emailstring required

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

max_filesinteger nullable

Response

Successful Response

job_idstring required
statusstring
custom_metadataobject nullable

The custom_metadata Captain accepted for this job, echoed back as validated. Null when none was supplied.

Changes

No recorded changes to this endpoint across all 1 revision of this API.