Small Talk Role
Update Product
PATCH /_api/v1/roleqa/product/info/{id}
Authorization
{{auth}}
REQUEST JSON
{ "title": "", "description": "", "rating": 0.0, "enabled": false }
| Item | Description |
|---|---|
title |
string If filled, it will overwrite |
description |
string If filled, it will overwrite |
rating |
number 0~5 |
enabled |
boolean Whether enabled |
RESPONSE JSON
{ “rc”: 0 }
### Form Q&A
#### Search Form
`POST /_api/v1/formqa/search`
**Authorization**
`{{auth}}`
**REQUEST JSON**
```json
{
"id": "",
"tableId": "",
"index": 0,
"onlyReturnCount": false,
"wheres": [{ "name": "", "compare": "", "value": "" }]
}
| Item | Description |
|---|---|
id |
string Primary key ID, if there is an ID, wheres will be ignored |
tableId |
string Form ID |
index |
number Page number |
onlyReturnCount |
boolean Whether to return only count |
wheres |
array conditions |
wheres[0].name |
string Field key (cannot be used for text fields) |
wheres[0].compare |
enum eq (keyword use eq equivalent to in), gt, lt, lte, gte |
wheres[0].value |
string If it is a date field, please use (seconds), if it is a number, please use a number |
Order and size are not supported temporarily, default size is 20 each time
RESPONSE JSON
{ "rc": 0, "error": "", "data": { "total_element": 0, "docs": [] } }
Form Trigger Action
POST /_api/v1/formqa/action
Trigger action API limits each trigger to 100 executions per hour including (loop counts), but it will not stop because of 100 times. Assuming it has run 99 times, if the last time has 100 times including loops, it will still execute the last time instead of stopping halfway.
Authorization
{{auth}}
REQUEST JSON
{ “parameters”: {}, “triggerId”: “”, “tableId”: “”, “guestId”: “” }
- `parameters`: object
```json
{
"product": "Product Name",
"price": 200,
"quantity": 5
}
| Item | Description |
|—|—|
| triggerId | string Trigger ID |
| tableId | string Form ID |
| guestId | string Anonymous User ID |
RESPONSE JSON
{
"rc": 0,
"error": "",
"data": { "error": false, "success": true, "response": "" }
}
data.errorRepresents that the trigger triggered an error nodedata.successRepresents that the trigger successfully reached the END nodercnot zero is an error message. This error may be because the API KEY is incorrect, or the parameters are incorrect, and error tells you why it is wrong.
Usage Notice
Currently, the server adopts start-on-use. If the API is called for the first time, it may take a little time, but it will return to normal time later.
Deprecated
/_api/v1/bot/chat
