Get document

info

• To add, read, modify, or delete data, a client write secret is required.
• The Document must include _id and title fields as mandatory.

Overview

Path

POST/v1/search/collections/{collectionName}/documents/{docId}

• Retrieves a Document from the Collection.

Example

---

curl -X GET https://api.invector.co/v1/collections/{collectionName}/documents/{docId} \
     -H "Content-Type: application/json" \
     -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \

Authorization

---

Authorization

BasicBasic authorization at Header. Base64 encoding required

client_id

string

client_secret

string

example

 curl -X GET https://api.invector.co/v1/collections/{collectionName}/documents/{docId} \
      -H "Content-Type: application/json" \
      -H "Authorization: Basic base64({CLIENT_ID}:{CLIENT_WRITE_SECRET})" \

Path Parameters

---

collectionName

string

docId

string

Response Body

---

200

objectDocument object

_id

stringUnique Document ID.

title

stringTitle of the document.

[other fields …]

anyOther fields of the document.

example

{
  "_id": "unique_document_id_123",
  "title": "Description of Philip",
  "name": "Philip",
  "age": 22,
  "department": "Engineering",
  "role": "Software Engineer",
  "email": "philipchoi@togglecampus.com"
}