Create Chunk Relation

POST

https://api.runcaptain.com/v3/collections/:collection_name/chunks/:chunk_id/relations

POST

/v3/collections/:collection_name/chunks/:chunk_id/relations

1 import json
2 import requests
3 import uuid
4 
5 BASE_URL = "https://api.runcaptain.com"
6 API_KEY = "your_api_key"
7 COLLECTION_NAME = "my_documents"
8 CHUNK_ID = "doc_abc123:0"
9 
10 headers = {
11     "Authorization": f"Bearer {API_KEY}",
12     "Content-Type": "application/json",
13     "Idempotency-Key": str(uuid.uuid4()),
14 }
15 
16 response = requests.post(
17     f"{BASE_URL}/v3/collections/{COLLECTION_NAME}/chunks/{CHUNK_ID}/relations",
18     headers=headers,
19     json={
20     "target_chunk_id": "chunk_ipcc_summary_014",
21     "target_document_id": "doc_ipcc_summary_2023",
22     "relation_type": "cites",
23     "metadata": {
24         "citation": "IPCC AR6 WGII Chapter 5"
25     }
26 },
27     timeout=30.0
28 )
29 
30 print(json.dumps(response.json(), indent=2))

Create a typed relation from one chunk to another chunk.

Path parameters

collection_namestringRequired

chunk_idstringRequired

Request

This endpoint expects an object.

target_chunk_idstringRequired

relation_typestringRequired

target_document_idstring or nullOptional

metadataobjectOptional

Response

Successful Response

relationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error