List Collections

GET

https://api.runcaptain.com/v2/collections

GET

/v2/collections

1 import requests
2 import json
3 
4 BASE_URL = "https://api.runcaptain.com"
5 API_KEY = "your_api_key"
6 ORG_ID = "your_organization_id"
7 
8 headers = {
9     "Authorization": f"Bearer {API_KEY}",
10     "X-Organization-ID": ORG_ID
11 }
12 
13 response = requests.get(
14     f"{BASE_URL}/v2/collections",
15     headers=headers,
16     timeout=30.0
17 )
18 
19 if response.status_code == 200:
20     data = response.json()
21     collections = data.get("collections", [])
22     print(f"Total collections: {len(collections)}")
23     for col in collections:
24         name = col.get("database_name", "Unknown")
25         count = col.get("file_count", 0)
26         print(f"  {name} ({count} files)")
27 else:
28     print(f"Error: {response.status_code}")
29     print(response.text)

200Retrieved

1 {
2   "collections": [
3     {
4       "database_name": "my-research-papers",
5       "file_count": 142,
6       "environment": "production",
7       "is_active": true,
8       "created_at": "2025-01-15T10:30:00Z",
9       "request_count": 1250
10     }
11   ],
12   "total_count": 1,
13   "limit": 100,
14   "offset": 0
15 }

List all collections for an organization.

Returns an array of collection objects with collection_name, collection_id, and document_count.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Response

Successful Response

collectionslist of objects

List of collections

total_countinteger

Number of collections returned

limitinteger

Maximum number of collections per page

offsetinteger

Pagination offset

Authentication

Headers

Response