Quickstart

$
curl -X PUT https://api.runcaptain.com/v2/collections/my_first_collection \
>
     -H "Authorization: Bearer $CAPTAIN_API_KEY" \
>
     -H "X-Organization-ID: $CAPTAIN_ORG_ID" \
>
     -H "Content-Type: application/json" \
>
     -d '{"description": "My first Captain Collection"}'

$
curl -X POST https://api.runcaptain.com/v2/collections/my_first_collection/index/s3 \
>
     -H "Authorization: Bearer $CAPTAIN_API_KEY" \
>
     -H "X-Organization-ID: $CAPTAIN_ORG_ID" \
>
     -H "Content-Type: application/json" \
>
     -d '{
>
       "bucket_name": "my-s3-bucket",
>
       "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
>
       "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
>
       "bucket_region": "us-east-1"
>
     }'

$
curl -X POST https://api.runcaptain.com/v2/collections/my_first_collection/index/gcs \
>
     -H "Authorization: Bearer $CAPTAIN_API_KEY" \
>
     -H "X-Organization-ID: $CAPTAIN_ORG_ID" \
>
     -H "Content-Type: application/json" \
>
     -d '{
>
       "bucket_name": "my-gcs-bucket",
>
       "service_account_json": "{\"type\":\"service_account\",\"project_id\":\"...\"}"
>
     }'

1
import time
2

3
while True:
4
    response = requests.get(
5
        f"{BASE_URL}/v2/jobs/{job_id}",
6
        headers={"Authorization": f"Bearer {API_KEY}"}
7
    )
8

9
    result = response.json()
10
    status = result.get('status')
11
    progress = result.get('progress_message', '')
12
    print(f"Status: {status} - {progress}")
13

14
    if status in ['completed', 'failed', 'cancelled']:
15
        if status == 'completed':
16
            print("Indexing complete!")
17
            final = result.get('result', {})
18
            print(f"Files indexed: {final.get('files_indexed', 0)}")
19
        break
20

21
    time.sleep(5)

$
curl -X POST https://api.runcaptain.com/v2/collections/my_first_collection/query \
>
     -H "Authorization: Bearer $CAPTAIN_API_KEY" \
>
     -H "X-Organization-ID: $CAPTAIN_ORG_ID" \
>
     -H "Content-Type: application/json" \
>
     -d '{
>
       "query": "What are the revenue projections for Q4?",
>
       "include_documents": true,
>
       "inference": true,
>
       "top_k": 80
>
     }'

$
curl -X POST https://api.runcaptain.com/v2/collections/my_first_collection/query \
>
     -H "Authorization: Bearer $CAPTAIN_API_KEY" \
>
     -H "X-Organization-ID: $CAPTAIN_ORG_ID" \
>
     -H "Content-Type: application/json" \
>
     -d '{
>
       "query": "What are the revenue projections for Q4?",
>
       "inference": false,
>
       "top_k": 20
>
     }'

1
import json
2

3
response = requests.post(
4
    f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/query",
5
    headers={
6
        "Authorization": f"Bearer {API_KEY}",
7
        "X-Organization-ID": ORG_ID,
8
        "Content-Type": "application/json"
9
    },
10
    json={
11
        "query": "Summarize all security incidents mentioned",
12
        "inference": True,  # Get LLM-generated answers based on the relevant sections that were retrieved
13
        "stream": True
14
    },
15
    stream=True  # Important: enable streaming
16
)
17

18
# Process streamed response
19
for line in response.iter_lines():
20
    if line:
21
        line_text = line.decode('utf-8')
22
        if line_text.startswith('data: '):
23
            data = line_text[6:]
24
            try:
25
                parsed = json.loads(data)
26
                if parsed.get('type') == 'stream_complete':
27
                    print("\nStream complete!")
28
                    break
29
            except json.JSONDecodeError:
30
                print(data, end='', flush=True)