Sign in

v47

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-06-17465244.2 KB
Database Management

Add Documents to a Collection

Add Documents to a Collection. You can add your documents to a Collection using this endpoint in the form of Json.

post/api/collections/data/add

Request body

collectionstring

The Name of the Collection or the Group where you want to store all your data.

docIdstring

The ID of the Document that you want to add. This is optional. If you don't pass a Document ID, we will generate a random ID for you. Make sure this is unique. You can add string data types as the Document ID, we will convert it automatically.

Example request

{
  "collection": "Users",
  "docId": "1234567890",
  "data": {
    "sampleDbContent": "This is a sample content",
    "sampleDbContent2": "This is a sample content 2"
  }
}

Response

Output from the Database Collection Addition Process

statusstring

Status indicating the success of the text moderation.

processing_timeinteger

The time taken to process the request, in milliseconds.

processing_idstring

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_countinteger

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

Example response

{
  "status": "success",
  "processing_time": 888,
  "processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
  "processing_count": 6554,
  "data": {
    "databaseId": "1234567890",
    "collection": "Users",
    "elapsed_time": 800,
    "documentId": "1234567890"
  }
}