Start Bot
curl --request POST \
--url http://localhost:8000/bot-orchestration/start-bot \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"bot_name": "<string>",
"log_level": "<string>",
"script": "<string>",
"conf": "<string>",
"async_backend": false
}
'import requests
url = "http://localhost:8000/bot-orchestration/start-bot"
payload = {
"bot_name": "<string>",
"log_level": "<string>",
"script": "<string>",
"conf": "<string>",
"async_backend": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bot_name: '<string>',
log_level: '<string>',
script: '<string>',
conf: '<string>',
async_backend: false
})
};
fetch('http://localhost:8000/bot-orchestration/start-bot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/bot-orchestration/start-bot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bot_name' => '<string>',
'log_level' => '<string>',
'script' => '<string>',
'conf' => '<string>',
'async_backend' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/bot-orchestration/start-bot"
payload := strings.NewReader("{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/bot-orchestration/start-bot")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/bot-orchestration/start-bot")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Bot Orchestration
Start Bot
Start a bot with the specified configuration.
Args: action: StartBotAction containing bot configuration parameters bots_manager: Bot orchestrator service dependency db_manager: Database manager dependency
Returns: Dictionary with status and response from bot start operation
POST
/
bot-orchestration
/
start-bot
Start Bot
curl --request POST \
--url http://localhost:8000/bot-orchestration/start-bot \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"bot_name": "<string>",
"log_level": "<string>",
"script": "<string>",
"conf": "<string>",
"async_backend": false
}
'import requests
url = "http://localhost:8000/bot-orchestration/start-bot"
payload = {
"bot_name": "<string>",
"log_level": "<string>",
"script": "<string>",
"conf": "<string>",
"async_backend": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
bot_name: '<string>',
log_level: '<string>',
script: '<string>',
conf: '<string>',
async_backend: false
})
};
fetch('http://localhost:8000/bot-orchestration/start-bot', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/bot-orchestration/start-bot",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'bot_name' => '<string>',
'log_level' => '<string>',
'script' => '<string>',
'conf' => '<string>',
'async_backend' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8000/bot-orchestration/start-bot"
payload := strings.NewReader("{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8000/bot-orchestration/start-bot")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/bot-orchestration/start-bot")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"bot_name\": \"<string>\",\n \"log_level\": \"<string>\",\n \"script\": \"<string>\",\n \"conf\": \"<string>\",\n \"async_backend\": false\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Action to start a bot
Name of the bot instance to act upon
Logging level (DEBUG, INFO, WARNING, ERROR)
Script name to run (without .py extension)
Configuration file name (without .yml extension)
Whether to run in async backend mode
Response
Successful Response
Was this page helpful?
⌘I

