List Documents

GET

https://api.captain.dev/v2/collections/:collection_name/documents

GET

/v2/collections/:collection_name/documents

1 import json
2 import requests
3 
4 BASE_URL = "https://api.captain.dev"
5 API_KEY = "your_api_key"
6 COLLECTION_NAME = "my_documents"
7 
8 headers = {
9     "Authorization": f"Bearer {API_KEY}",
10 }
11 
12 params = {
13     "limit": 10,
14     "offset": 0
15 }
16 
17 response = requests.get(
18     f"{BASE_URL}/v2/collections/{COLLECTION_NAME}/documents",
19     headers=headers,
20     params=params,
21     timeout=30.0
22 )
23 
24 print(json.dumps(response.json(), indent=2))

200Retrieved

1 {
2   "collection_name": "user_documents",
3   "documents": [
4     {
5       "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
6       "filename": "project_proposal.pdf",
7       "chunk_count": 5,
8       "content_type": "application/pdf",
9       "created_at": "2024-05-20T10:15:30Z",
10       "indexed_at": "2024-05-21T08:00:00Z",
11       "indexing_status": "completed",
12       "uri": "https://storage.example.com/user_documents/project_proposal.pdf"
13     },
14     {
15       "document_id": "b2c3d4e5-f6a7-8901-bc23-de45fa678901",
16       "filename": "field-notes-images.zip",
17       "chunk_count": 18,
18       "content_type": "application/zip",
19       "created_at": "2024-05-22T14:12:09Z",
20       "indexed_at": "2024-05-22T14:45:30Z",
21       "indexing_status": "completed",
22       "uri": "s3://customer-bucket/user_documents/field-notes-images.zip"
23     },
24     {
25       "document_id": "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
26       "filename": "crop_yield_timeseries.xlsx",
27       "chunk_count": 24,
28       "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
29       "created_at": "2024-06-01T11:04:18Z",
30       "indexed_at": "2024-06-01T11:10:02Z",
31       "indexing_status": "completed",
32       "uri": "https://storage.example.com/user_documents/crop_yield_timeseries.xlsx"
33     }
34   ],
35   "limit": 10,
36   "offset": 0,
37   "total_count": 125
38 }

List documents in a collection with pagination.

Path parameters

collection_namestringRequired

Query parameters

limitintegerOptional1-1000Defaults to 100

offsetintegerOptional>=0Defaults to 0

Response

Successful Response

collection_namestring

documentslist of objects

limitinteger

offsetinteger

total_countinteger