Skip to main content
POST
/
tasks
/
{session_id}
/
command
Stop a running task any time.
curl --request POST \
  --url https://browser.ai/api/v1/tasks/{session_id}/command \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "stop"
}
'
import requests

url = "https://browser.ai/api/v1/tasks/{session_id}/command"

payload = { "command": "stop" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({command: 'stop'})
};

fetch('https://browser.ai/api/v1/tasks/{session_id}/command', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://browser.ai/api/v1/tasks/{session_id}/command",
  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([
    'command' => 'stop'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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 := "https://browser.ai/api/v1/tasks/{session_id}/command"

	payload := strings.NewReader("{\n  \"command\": \"stop\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	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("https://browser.ai/api/v1/tasks/{session_id}/command")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"command\": \"stop\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://browser.ai/api/v1/tasks/{session_id}/command")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"command\": \"stop\"\n}"

response = http.request(request)
puts response.read_body
{
  "message": "Task stopped successfully"
}
{
  "error": "Invalid command or task ID"
}
{
  "error": "Unauthorized"
}
{
  "error": "Task not found"
}
{
  "error": "Internal server error"
}

Authorizations

​
Authorization
string
header
required

Insert API token, use the format: apikey <API-TOKEN>.

Path Parameters

​
session_id
string
required

Insert your task’s session ID located in your Projects dashboard.

Body

application/json
​
command
enum<string>
required

The command to send to the task. Currently only 'stop' is supported.

Available options:
stop

Response

Command accepted and processed