Cancel queued tasks
curl --request POST \
--url 'https://api.vida.dev/api/v2/tasks/cancel?token=' \
--header 'Content-Type: application/json' \
--data '
{
"taskIds": [
"<string>"
],
"batchId": "<string>",
"allPending": false
}
'import requests
url = "https://api.vida.dev/api/v2/tasks/cancel?token="
payload = {
"taskIds": ["<string>"],
"batchId": "<string>",
"allPending": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({taskIds: ['<string>'], batchId: '<string>', allPending: false})
};
fetch('https://api.vida.dev/api/v2/tasks/cancel?token=', 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://api.vida.dev/api/v2/tasks/cancel?token=",
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([
'taskIds' => [
'<string>'
],
'batchId' => '<string>',
'allPending' => false
]),
CURLOPT_HTTPHEADER => [
"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://api.vida.dev/api/v2/tasks/cancel?token="
payload := strings.NewReader("{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.vida.dev/api/v2/tasks/cancel?token=")
.header("Content-Type", "application/json")
.body("{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/tasks/cancel?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"requested": 3,
"matched": 3,
"canceled": 2,
"skipped": 1,
"batchId": "f52b1e01-5cbc-483c-9939-3bf7d37e1426",
"canceledTaskIds": [
"task-id-1",
"task-id-2"
]
}Tasks
Cancel queued tasks
Atomically cancel pending Tasks without deleting their audit history. Provide exactly one selector: taskIds, batchId, or allPending=true. Running and terminal selected or batch Tasks are reported as skipped. Cancellation does not interrupt an in-flight attempt.
POST
/
api
/
v2
/
tasks
/
cancel
Cancel queued tasks
curl --request POST \
--url 'https://api.vida.dev/api/v2/tasks/cancel?token=' \
--header 'Content-Type: application/json' \
--data '
{
"taskIds": [
"<string>"
],
"batchId": "<string>",
"allPending": false
}
'import requests
url = "https://api.vida.dev/api/v2/tasks/cancel?token="
payload = {
"taskIds": ["<string>"],
"batchId": "<string>",
"allPending": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({taskIds: ['<string>'], batchId: '<string>', allPending: false})
};
fetch('https://api.vida.dev/api/v2/tasks/cancel?token=', 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://api.vida.dev/api/v2/tasks/cancel?token=",
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([
'taskIds' => [
'<string>'
],
'batchId' => '<string>',
'allPending' => false
]),
CURLOPT_HTTPHEADER => [
"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://api.vida.dev/api/v2/tasks/cancel?token="
payload := strings.NewReader("{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.vida.dev/api/v2/tasks/cancel?token=")
.header("Content-Type", "application/json")
.body("{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vida.dev/api/v2/tasks/cancel?token=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"taskIds\": [\n \"<string>\"\n ],\n \"batchId\": \"<string>\",\n \"allPending\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"requested": 3,
"matched": 3,
"canceled": 2,
"skipped": 1,
"batchId": "f52b1e01-5cbc-483c-9939-3bf7d37e1426",
"canceledTaskIds": [
"task-id-1",
"task-id-2"
]
}Authorizations
Vida API Token
Query Parameters
Limit cancellation to one agent account in the organization
Body
application/json
⌘I