OpenAPI 3.0 definition of Coderbot API v3 v1.0

Scroll down for example requests and responses.

Base URLs:

• http://coderbot.local/api/v1

CoderBot configuration

api.loadSettings ​

Code samples

GET /settings

Load settings

Responses

api.saveSettings ​

Code samples

PUT /settings

Save settings

Body parameter

{}

Parameters

Responses

api.restoreSettings ​

Code samples

POST /settings/restore

Restore settings to default

Responses

Photos management

api.listPhotos ​

Code samples

GET /media

Get the list of all photos

Responses

api.takePhoto ​

Code samples

POST /media

take a new photo

Responses

api.getPhoto ​

Code samples

GET /media/{name}

Get photo by name

Parameters

Example responses

200 Response

Responses

api.savePhoto ​

Code samples

PUT /media/{name}

Save photo by name

Body parameter

{
  "name": "string",
  "tag": "string"
}

Parameters

Responses

api.deletePhoto ​

Code samples

DELETE /media/{name}

Delete photo by name

Parameters

Responses

Video management

api.streamVideo ​

Code samples

GET /video/stream

Stream video

Responses

api.recVideo ​

Code samples

POST /video/rec

Rec video

Responses

api.stopVideo ​

Code samples

POST /video/stop

Stop rec video

Responses

Program management

api.listPrograms ​

Code samples

GET /programs

Get the list of all the saved programs

Responses

api.loadProgram ​

Code samples

GET /programs/{name}

Get the program with the specified name

Parameters

Responses

api.deleteProgram ​

Code samples

DELETE /programs/{name}

Delete a program

Parameters

Responses

api.saveProgram ​

Code samples

PUT /programs/{name}

Save an existing program

Body parameter

{
  "name": "string",
  "code": "string",
  "dom_code": "string",
  "default": true,
  "overwrite": true
}

Parameters

Responses

api.runProgram ​

Code samples

POST /programs/{name}/run

Execute the given program

Body parameter

{
  "name": "string",
  "code": "string",
  "dom_code": "string",
  "default": true,
  "overwrite": true
}

Parameters

Responses

api.statusProgram ​

Code samples

GET /programs/{name}/status

Get the status of the given program

Parameters

Responses

api.stopProgram ​

Code samples

PATCH /programs/{name}/stop

Stop the given program

Parameters

Responses

Activity management

api.listActivities ​

Code samples

GET /activities

Get the list of all the saved activities

Responses

api.saveAsNewActivity ​

Code samples

POST /activities

Save a new activity

Body parameter

{
  "name": "string",
  "description": "string",
  "default": true,
  "stock": true
}

Parameters

Responses

api.loadActivity ​

Code samples

GET /activities/{name}

Get the activity with the specified name

Parameters

Responses

api.saveActivity ​

Code samples

PUT /activities/{name}

Save the activity with the specified name

Body parameter

{
  "name": "string",
  "description": "string",
  "default": true,
  "stock": true
}

Parameters

Responses

api.deleteActivity ​

Code samples

DELETE /activities/{name}

Delete an activity

Parameters

Responses

Music extensions

api.listMusicPackages ​

Code samples

GET /music/packages

List Music Packages

Responses

api.deleteMusicPackage ​

Code samples

DELETE /music/packages/{name}

Delete Music Package

Parameters

Responses

System operations

api.addMusicPackage ​

Code samples

POST /music/packages

Add Music Package

Body parameter

{}

Parameters

Responses

api.get_status ​

Code samples

GET /system/status

Bot general informations, execution status and reset log file

Responses

api.testCoderbot ​

Code samples

POST /system/test

Tests CoderBot components.

Body parameter

{
  "tests": [
    "string"
  ]
}

Parameters

Responses

api.get_info ​

Code samples

GET /system/info

Bot general informations and execution status

Responses

api.halt ​

Code samples

POST /system/halt

Halt system (system shutdown)

Responses

api.reset ​

Code samples

POST /system/reset

Reset all local configuration to factory state

Responses

api.restart ​

Code samples

POST /system/restart

Restart backend

Responses

api.reboot ​

Code samples

POST /system/reboot

Reboot all device

Responses

Direct control

api.stop ​

Code samples

POST /control/stop

Stops the bot motors

Responses

api.move ​

Code samples

POST /control/move

Moves the bot forward or backward.

Body parameter

{
  "speed": -100,
  "elapse": -1
}

Parameters

Responses

api.turn ​

Code samples

POST /control/turn

Make a turn with the motors

Body parameter

{
  "speed": -100,
  "elapse": -1
}

Parameters

Responses

api.speak ​

Code samples

POST /control/speak

Pronounce a phrase

Body parameter

{
  "text": "string",
  "locale": "st"
}

Parameters

Responses

CNN Models

api.listCNNModels ​

Code samples

GET /cnnmodels

list of CNN Models

Responses

api.trainCNNModel ​

Code samples

POST /cnnmodels

train new CNN Model

Body parameter

{}

Parameters

Responses

api.getCNNModel ​

Code samples

GET /cnnmodels/{name}

get CNN Model

Parameters

Responses

api.deleteCNNModel ​

Code samples

DELETE /cnnmodels/{name}

delete CNN Model

Parameters

Responses

Schemas ​

MoveParamsElapse

{
  "speed": -100,
  "elapse": -1
}

Properties ​

MoveParamsDistance

{
  "speed": -100,
  "distance": 1000
}

Properties ​

TurnParamsElapse

{
  "speed": -100,
  "elapse": -1
}

Properties ​

TurnParamsDistance

{
  "speed": -100,
  "distance": 100000
}

Properties ​

Settings

{}

Properties ​

None

Photo

{
  "name": "string",
  "tag": "string"
}

Properties ​

Program

{
  "name": "string",
  "code": "string",
  "dom_code": "string",
  "default": true,
  "overwrite": true
}

Properties ​

Activity

{
  "name": "string",
  "description": "string",
  "default": true,
  "stock": true
}

Properties ​