v47

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

Database Management

Fetch a Document from a Collection

Fetch a Document from a Collection. This is useful when you want to fetch a specific Document from a Collection and perform some operations on it.

post/api/collections/data/fetch/document

Request body

collectionstring

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

documentIdstring

The ID of the Document that you want to fetch.

Example request

{
  "collection": "Users",
  "documentId": "1234567890"
}

Response

Output from the Database Collection Fetch 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,
    "data": [
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      },
      {
        "sampleDbContent": "This is a sample content",
        "sampleDbContent2": "This is a sample content 2"
      }
    ]
  }
}