Index Azure File | Captain Docs

import requests
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
ORG_ID = "your_organization_id"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "X-Organization-ID": ORG_ID,
    "Content-Type": "application/json"
}
response = requests.post(
    f"{BASE_URL}/v2/collections/my_documents/index/azure/file",
    headers=headers,
    json={
        "container_name": "my-container",
        "file_uri": "https://mystorageaccount.blob.core.windows.net/my-container/contracts/acme_contract.pdf",
        "account_name": "mystorageaccount",
        "account_key": "your_account_key",
        "processing_type": "advanced"
    },
    timeout=60.0
)
if response.status_code in [200, 201]:
    result = response.json()
    print(f"Job started! Job ID: {result.get('job_id')}")
else:
    print(f"Error: {response.status_code}")

{
  "job_id": "abc123xyz-1234567890",
  "status": "pending"
}

Index a single file from an Azure Blob Storage container into a collection. Returns a job_id for tracking progress.

Path parameters

collection_namestringRequired

Name of the collection to index into

Request

This endpoint expects an object.

container_namestringRequired

Name of the Azure Blob Storage container

file_uristringRequired

Azure Blob Storage URI format: https://{account}.blob.core.windows.net/{container}/path/to/file.pdf

account_namestringRequired

Azure Storage account name

account_keystringRequired

Azure Storage account key (base64-encoded)

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:

custom_metadatamap from strings to anyOptional

Custom metadata to attach to all chunks from this file. Keys must be strings. Values: str, int, float, bool, or array of strings.

Response

Indexing Job Started

job_idstring

statusenum

Allowed values:

Path parameters

Headers

Request

Response