indexing

Index File

Index uploaded files into a collection.

Upload one or more files directly via multipart form-data. Supports PDF, DOCX, XLSX, CSV, TXT, images, and other document types. Files are processed through the same pipeline as cloud storage indexing.

Headers:

  • Authorization: Bearer {api_key} - Captain API key for authentication
  • X-Organization-ID: Organization UUID
  • Idempotency-Key: UUID for request deduplication (optional)

Args: collection_name: Name of the collection (path parameter) files: One or more files to upload and index processing_type: "advanced" or "basic" (default: "basic") custom_metadata: JSON string of custom metadata (optional)

Returns: { job_id, status: "pending" }

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

Path parameters

collection_namestring required

Headers

authorizationstring 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.