List Documents

GET

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

GET

/v2/collections/:collection_name/documents

1 import requests
2 
3 BASE_URL = "https://api.runcaptain.com"
4 API_KEY = "your_api_key"
5 ORG_ID = "your_organization_id"
6 
7 headers = {
8     "Authorization": f"Bearer {API_KEY}",
9     "X-Organization-ID": ORG_ID
10 }
11 
12 response = requests.get(
13     f"{BASE_URL}/v2/collections/my_documents/documents",
14     headers=headers,
15     params={"limit": 100, "offset": 0},
16     timeout=30.0
17 )
18 
19 if response.status_code == 200:
20     data = response.json()
21     documents = data.get('documents', [])
22     print(f"Found {len(documents)} document(s)")
23 else:
24     print(f"Error: {response.status_code}")

Try it

200Retrieved

1 {
2   "documents": [
3     {
4       "document_id": "doc_abc123",
5       "document_name": "contract.pdf",
6       "created_at": "2024-01-15T10:30:00Z",
7       "updated_at": "2024-01-15T10:30:00Z"
8     }
9   ],
10   "total_count": 1
11 }

List all documents in a collection with pagination support.

Path parameters

collection_namestringRequired

Name of the collection

Query parameters

limitintegerOptionalDefaults to 100

Maximum number of documents to return

offsetintegerOptionalDefaults to 0

Pagination offset

Response

Successful Response

documentslist of objects or null

total_countinteger or null

Path parameters

Headers

Query parameters

Response