API Schemas

​

Headers

• A Content-Type header specifying the request payload format
• A X-Api-Token header containing the authentication token for request authorization

curl --request POST \
  --url https://{api-address}.org.machina.gg/agent \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{}'

​

Sort, Filter and Paginate

• The filters object defines filtering mechanism criteria
• The sorters array defines a sorting mechanism
  • First a property to defines sorting criteria
  • Second, 1 for ascending, -1 for descending
• The page and page_size properties defines specific page and the limit of items

{
  "filters": {
    "name": "Conversational Agent"
  },
  "sorters": [
    "_id",
    1
  ],
  "page": 1,
  "page_size": 10
}

​

Next up