Create a Collection
curl --request POST \
--url https://api.worqhat.com/api/collections/create \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collection": "Users",
"collectionSchema": {
"address": "json",
"age": "number",
"date_of_birth": "date",
"hobbies": "array",
"id": "uuid",
"ip_address": "ip",
"is_active": "boolean",
"location": "geopoint",
"name": "string",
"timestamp": "timestamp",
"weight": "float"
},
"collectionSortBy": "name"
}'
{
"database": {
"collection": "Users",
"elapsed_time": 800
},
"processing_count": 6554,
"processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
"processing_time": 888,
"status": "success"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The Name of the Collection or the Group where you want to store all your data.
The Schema of the Collection. This is used to validate the data that is being stored in the Collection. This is optional. You can pass in the variables on how you want to structure the data as. We currently support Data Types such as string
, number
, float
, boolean
, date
, timestamp
, json
, map
, array
, geopoint
, uuid
, ip
.
The Field by which you want to sort the data in the Collection. This is optional. By default we will sort it by the Document Creation Time of the data that you add.
Response
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.
A universally unique identifier for the request. This can be used to track the request in the logs.
The time taken to process the request, in milliseconds.
Status indicating the success of the text moderation.
Was this page helpful?
curl --request POST \
--url https://api.worqhat.com/api/collections/create \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"collection": "Users",
"collectionSchema": {
"address": "json",
"age": "number",
"date_of_birth": "date",
"hobbies": "array",
"id": "uuid",
"ip_address": "ip",
"is_active": "boolean",
"location": "geopoint",
"name": "string",
"timestamp": "timestamp",
"weight": "float"
},
"collectionSortBy": "name"
}'
{
"database": {
"collection": "Users",
"elapsed_time": 800
},
"processing_count": 6554,
"processing_id": "4b139bfe-1f71-4345-b539-fa6c1700f166",
"processing_time": 888,
"status": "success"
}