Get Document - v2 (Legacy)

GET

https://host.com/v2/collections/:collection_name/documents/:document_id

GET

/v2/collections/:collection_name/documents/:document_id

1 import requests
2 
3 url = "https://host.com/v2/collections/collection_name/documents/document_id"
4 
5 response = requests.get(url)
6 
7 print(response.json())

200Retrieved

1 {
2   "chunk_count": 1,
3   "chunks": [
4     {
5       "chunk_id": "chunk_id",
6       "content": "content",
7       "chunk_index": 1,
8       "regions": [
9         {}
10       ],
11       "custom_metadata": {
12         "key": "value"
13       },
14       "relations": [
15         {
16           "relation_id": "relation_id",
17           "source_chunk_id": "source_chunk_id",
18           "target_chunk_id": "target_chunk_id",
19           "relation_type": "relation_type",
20           "target_status": "target_status",
21           "metadata": {
22             "key": "value"
23           }
24         }
25       ],
26       "related_chunks": [
27         {
28           "chunk_id": "chunk_id"
29         }
30       ],
31       "metadata": {
32         "key": "value"
33       },
34       "page_start": 1,
35       "page_end": 1,
36       "start_sec": 1.1,
37       "end_sec": 1.1,
38       "tokens": 1,
39       "category": "category",
40       "parent_chunk_index": 1
41     }
42   ],
43   "collection_name": "collection_name",
44   "document_id": "document_id",
45   "metadata": {
46     "created_at": "created_at",
47     "file_size": 1,
48     "file_type": "file_type",
49     "filename": "filename",
50     "indexed_at": "indexed_at",
51     "indexing_status": "indexing_status",
52     "mime_type": "mime_type",
53     "summary": "summary",
54     "tags": [
55       "tags"
56     ],
57     "uri": "uri",
58     "custom_metadata": {
59       "key": "value"
60     }
61   },
62   "regions": [
63     {
64       "type": "type",
65       "text": "text",
66       "page": 1,
67       "confidence": 1.1,
68       "image_url": "image_url",
69       "description": "description",
70       "region_id": "region_id",
71       "metadata": {
72         "key": "value"
73       }
74     }
75   ]
76 }

Retrieve a single document by ID using the v2 compatibility shape.

Path parameters

collection_namestringRequired

document_idstringRequired

Response

Successful Response

chunk_countinteger

chunkslist of objects

collection_namestring

document_idstring

metadataobject

regionslist of objects