Create Collection

PUT

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

PUT

/v2/collections/:collection_name

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 COLLECTION_NAME = "my_documents"
8 
9 headers = {
10     "Authorization": f"Bearer {API_KEY}",
11     "X-Organization-ID": ORG_ID,
12     "Content-Type": "application/json"
13 }
14 
15 response = requests.put(
16     f"{BASE_URL}/v2/collections/{COLLECTION_NAME}",
17     headers=headers,
18     json={},
19     timeout=30.0
20 )
21 
22 if response.status_code in [200, 201]:
23     print("Collection created successfully!")
24     print(json.dumps(response.json(), indent=2))
25 else:
26     print(f"Error: {response.status_code}")
27     print(response.text)

200Updated

1 {
2   "collection_name": "my_documents",
3   "collection_id": "019abc12-3456-7890-abcd-ef1234567890",
4   "status": "created",
5   "message": "Collection 'my_documents' created successfully"
6 }

Create a new collection (idempotent). Returns 201 if created, 200 if already exists.

Authentication

AuthorizationBearer

Bearer token authentication using API key

Path parameters

collection_namestringRequired

Request

This endpoint expects an object.

descriptionstringOptional

Response

Collection Already Exists

collection_namestring

collection_idstring or null

statusstring or null

messagestring or null

Authentication

Path parameters

Headers

Request

Response