Index Text

POST

https://api.runcaptain.com/v2/collections/:collection_name/index/text

Index plain text content into a collection.

Accepts raw text content in the request body, saves it as a .txt file, and indexes it for semantic search. No file upload or cloud storage needed.

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) body: Text content and optional metadata

Returns: { job_id, status: “pending” }

Index plain text content into a collection. Accepts raw text content in the request body, saves it as a .txt file, and indexes it for semantic search. No file upload or cloud storage needed. 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) body: Text content and optional metadata Returns: { job_id, status: "pending" }

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

contentstringRequired

The text content to index.

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

filenamestring or nullOptional

Optional filename for the text document. Defaults to ‘snippet-{N}.txt’ where N auto-increments.

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.

Response

Successful Response

job_idstring

statusstringOptionalDefaults to pending

1	import requests
2
3	BASE_URL = "https://api.runcaptain.com"
4	API_KEY = "your_api_key"
5
6	headers = {"Authorization": f"Bearer {API_KEY}"}
7
8	response = requests.post(
9	f"{BASE_URL}/v2/collections/{collection_name}/index/text",
10	headers=headers,
11	json={"text": "Captain supports multilingual video and audio transcription with automatic language detection.", "file_name": "release-notes.txt", "processing_type": "advanced"},
12	timeout=60.0
13	)
14	print(response.json())

1	{
2	"job_id": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6-1783111725",
3	"status": "pending"
4	}