List Collections | Captain Docs

import requests
import json
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v2/collections",
    headers=headers,
    timeout=30.0
)
if response.status_code == 200:
    data = response.json()
    collections = data.get("collections", [])
    print(f"Total collections: {len(collections)}")
    for col in collections:
        name = col.get("database_name", "Unknown")
        count = col.get("file_count", 0)
        print(f"  {name} ({count} files)")
else:
    print(f"Error: {response.status_code}")
    print(response.text)

{
  "collections": [
    {
      "database_name": "my-research-papers",
      "file_count": 142,
      "environment": "production",
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "request_count": 1250,
      "collection_id": "col_9f8e7d6c5b4a3",
      "collection_name": "legal_contracts_2024",
      "document_count": 42
    }
  ],
  "total_count": 1,
  "limit": 100,
  "offset": 0
}

List collections for an organization with pagination.

Returns a paginated array of collection objects. Use limit and offset query parameters to page through results. The total_count field in the response indicates the total number of collections available across all pages.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Response

Successful Response

collectionslist of objects

List of collections

total_countinteger

Total number of collections across all pages (not just the current page)

limitinteger

Maximum number of collections per page

offsetinteger

Pagination offset

Authentication

Headers

Response