Index Text | 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_collection/index/text",
    headers=headers,
    json={
        "content": '''
Machine learning is a subset of artificial intelligence
that enables systems to learn and improve from experience.
Key concepts include:
- Supervised learning: training with labeled data
- Unsupervised learning: finding patterns in unlabeled data
- Reinforcement learning: learning through trial and error
Applications range from image recognition and natural
language processing to autonomous vehicles and
predictive analytics.
''',
        "filename": "ml_notes.txt"
    },
    timeout=60.0
)
if response.status_code in [200, 201]:
    data = response.json()
    print(f"Job started! ID: {data['job_id']}")
else:
    print(f"Error: {response.status_code}")

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

Index plain text content into a collection.

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

Text is always processed as basic (no OCR). Ideal for indexing scraped content, notes, articles, or any plain text data.

Returns a job_id for tracking progress via GET /v2/jobs/{job_id}.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

collection_namestringRequired

Name of the collection to index into

Headers

X-Organization-IDstringRequired

Idempotency-KeystringOptional

UUID for request deduplication

Request

This endpoint expects an object.

contentstringRequired

The text content to index.

filenamestringOptional

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

custom_metadatamap from strings to anyOptional

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

Response

Indexing job started

job_idstring

statusenum

Allowed values: