Index SharePoint Site | Captain Docs

Index a SharePoint site’s document library into a collection (headless).

Uses Microsoft Graph app-only auth (Entra ID App Registration with Sites.Selected or Sites.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” }

Index a SharePoint site's document library into a collection (headless). Uses Microsoft Graph app-only auth (Entra ID App Registration with Sites.Selected or Sites.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" }

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.

Allowed values:

site_urlstringRequired

SharePoint site URL (e.g. ‘https://contoso.sharepoint.com/sites/Sales’) or an already-resolved Graph site ID. The site’s default document library is indexed unless drive_id is given. With Sites.Selected, the admin must have granted this app access to this site.

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.

pii_engineenumOptionalDefaults to kev

Masking engine for this job. kev (default): the Kev classifier model on Captain’s infrastructure; supports pii_fields and pii_instructions; no fallback, so a file kev cannot mask fails to index and the rest of the job continues. jev: TypeSafe’s hosted Jev model, slightly more accurate, best-effort availability; supports custom fields and instructions and may list fallbacks in pii_fallback. presidio: the legacy pattern engine, built-in categories only (rejects pii_fields or pii_instructions with 422), never a fallback. Requires mask_pii: true. The earlier names captain-jev and captain-presidio keep working as before; new requests should use kev, jev or presidio.

Allowed values:

pii_fallbackobject or booleanOptional

Ordered fallback engines for jev, as {"engines": [...], "retry_budget_seconds": n}. Omitted or an empty engines list means no fallback. Only valid with pii_engine: "jev"; with kev or presidio a non-empty list answers 422. On the multipart file upload endpoint, send it as a JSON string form field. With the earlier engine name captain-jev it is true (default, fall back to captain-presidio) or false.

pii_fieldslist of objects or nullOptional

Additional PII categories to mask for this job, on top of the built-in set. Requires mask_pii to be true. Up to 20 fields. Each masked value is replaced with the field’s tag in angle brackets and appears in the masking report under the field’s name.

pii_instructionsstring or nullOptional<=1000 characters

Plain-language guidance that steers what counts as personal data for this job, for the built-in categories and any pii_fields. For example: ‘Names of hospital staff may stay; patient names, record numbers and bed assignments must be masked.’ Requires mask_pii to be true. Up to 1,000 characters.

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

drive_idstring or nullOptional

Optional Graph drive ID of a specific document library, when the site has more than the default 'Documents' library.

max_filesinteger or nullOptional

Response

Successful Response

job_idstring

statusstringOptionalDefaults to pending

custom_metadatamap from strings to any or nullOptional

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

Errors

400

Bad Request Error