List Documents | Captain Docs

import requests
import json
BASE_URL = "https://api.runcaptain.com"
API_KEY = "your_api_key"
ORG_ID = "your_organization_id"
COLLECTION_NAME = "my_documents"
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "X-Organization-ID": ORG_ID
}
response = requests.get(
    f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/documents",
    params={"limit": 50, "offset": 0},
    headers=headers,
    timeout=30.0
)
if response.status_code == 200:
    data = response.json()
    print(f"Total documents: {data.get('total_count', 0)}")
    for doc in data.get("documents", []):
        print(f"  {doc['filename']} ({doc['content_type']})")
else:
    print(f"Error: {response.status_code}")

{
  "documents": [
    {
      "file_id": "doc_abc123",
      "filename": "quarterly-report-q4.pdf",
      "content_type": "application/pdf",
      "chunk_count": 24,
      "created_at": "2025-01-15T10:30:00Z",
      "indexed_at": "2025-01-15T10:32:00Z"
    }
  ],
  "total_count": 142,
  "limit": 50,
  "offset": 0,
  "collection_name": "my_documents"
}

List all documents in a collection with pagination support.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

collection_namestringRequired

Query parameters

offsetintegerOptionalDefaults to 0

Pagination offset

Response

Successful Response

documentslist of objects

List of documents in the collection

total_countinteger

Total number of documents in the collection across all pages

limitinteger

Maximum number of documents per page

offsetinteger

Pagination offset

collection_namestring

Name of the collection

Authentication

Path parameters

Headers

Query parameters

Response