Skip to content

Latest commit

 

History

History
87 lines (70 loc) · 2.38 KB

api.rest

File metadata and controls

87 lines (70 loc) · 2.38 KB

// Details on how to use at the bottom of the file

### Login on the Admin UI # @name login POST {{baseUrl}}/api/v1/auth/login/basic/default Content-Type: application/x-www-form-urlencoded

email={{email}}&password={{password}}

### @authToken = {{login.response.body.payload.jwt}}

### List All Bots (need to login first) GET {{baseUrl}}/api/v1/admin/bots Authorization: Bearer {{authToken}} X-BP-Workspace: default

### @botId = YOUR_BOT_ID

### Send a request using Converse POST {{baseUrl}}/api/v1/bots/{{botId}}/converse/benchmarkUser Content-Type: application/json

{
"type": "text", "text": "hey"

}

### Test Duckling POST https://duckling.botpress.io/parse Content-Type: application/x-www-form-urlencoded

text=hello how are you today &lang=en &reftime={{$datetime "xx"}} &tz=America/Toronto

### Reboot server POST {{baseUrl}}/api/v1/admin/server/rebootServer Authorization: Bearer {{authToken}} X-BP-Workspace: default

### Test Lang Server GET https://lang-01.botpress.io/info

### Get server archive (pull) GET {{baseUrl}}/api/v1/admin/versioning/export Content-Type:application/tar+gzip Authorization: Bearer {{authToken}} # Once you get the response, save it to archive.tgz using the second button in the top right of the response window 'Save response body'

### The two following requests requires BPFS_STORAGE=database ### Check for changes POST {{baseUrl}}/api/v1/admin/versioning/changes Content-Type: application/xml Authorization: Bearer {{authToken}} # Set the absolute path of the archive, or relative to where VS Code was executed from < ./.rest-client/responses/body/archive.tgz

### Push changes POST {{baseUrl}}/api/v1/admin/versioning/update Content-Type: application/xml Authorization: Bearer {{authToken}} # Set the absolute path of the archive, or relative to where VS Code was executed from < ./.rest-client/responses/body/archive.tgz

### SETUP

# Use with https://marketplace.visualstudio.com/items?itemName=humao.rest-client

# 1) Configure environment variable in VS Code # - Open settings.json and add that snippet (replace vars as wanted for different environments) # # "rest-client.environmentVariables": { # "$shared": { # "baseUrl": "http://localhost:3000", # "email": "admin", # "password": "123456" # }, # "local": { # "baseUrl": "http://localhost:3000" # }, # "production": { # "baseUrl": "https://botpress.com", # } # }