Kalliope provides the REST API to manage the synapses. For configuring the API refer to the settings documentation.
Note: --user is only needed if
password_protected
is True
Normal response codes: 200 Error response codes: unauthorized(401), itemNotFound(404) Curl command:
curl -i --user admin:secret -X GET http://localhost:5000/synapses/
Output example:
{
"synapses": [
[
{
"name": "stop-kalliope",
"neurons": [
{
"say": {
"message": "Good bye"
}
},
"kill_switch"
],
"signals": [
{
"order": "close"
}
]
}
],
[
{
"name": "say-hello",
"neurons": [
{
"say": {
"message": [
"Bonjour monsieur"
]
}
}
],
"signals": [
{
"order": "bonjour"
}
]
}
]
]
}
Normal response codes: 200 Error response codes: unauthorized(401), itemNotFound(404) Curl command:
curl -i --user admin:secret -X GET http://localhost:5000/synapses/say-hello
Output example:
{
"synapses": {
"name": "say-hello",
"neurons": [
{
"say": {
"message": [
"Bonjour monsieur"
]
}
}
],
"signals": [
{
"order": "bonjour"
}
]
}
}
Normal response codes: 201 Error response codes: unauthorized(401), itemNotFound(404) Curl command:
curl -i --user admin:secret -X POST http://localhost:5000/synapses/say-hello
Output example:
{
"synapses": {
"name": "say-hello",
"neurons": [
{
"say": {
"message": [
"Bonjour monsieur"
]
}
}
],
"signals": [
{
"order": "bonjour"
}
]
}
}
Method | URL | Action |
---|---|---|
GET | /synapses | List synapses |
GET | /synapses/ | Show synapse details |
POST | /synapses/ | Run a synapse |