Cancel a run
curl --request POST \
--url https://agent.getmodus.com/agent/v1/runs/{runId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"reason": "<string>",
"lastSeenEventId": "<string>"
}
'import requests
url = "https://agent.getmodus.com/agent/v1/runs/{runId}/cancel"
payload = {
"organizationId": "<string>",
"reason": "<string>",
"lastSeenEventId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({organizationId: '<string>', reason: '<string>', lastSeenEventId: '<string>'})
};
fetch('https://agent.getmodus.com/agent/v1/runs/{runId}/cancel', 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://agent.getmodus.com/agent/v1/runs/{runId}/cancel",
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([
'organizationId' => '<string>',
'reason' => '<string>',
'lastSeenEventId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://agent.getmodus.com/agent/v1/runs/{runId}/cancel"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://agent.getmodus.com/agent/v1/runs/{runId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent.getmodus.com/agent/v1/runs/{runId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyRuns · Streaming
Cancel a run
Idempotently cancel an in-flight or queued run. The owning replica aborts the run and a terminal cancelled event lands on any watching SSE stream.
Requires: workflows:invoke
POST
/
agent
/
v1
/
runs
/
{runId}
/
cancel
Cancel a run
curl --request POST \
--url https://agent.getmodus.com/agent/v1/runs/{runId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"organizationId": "<string>",
"reason": "<string>",
"lastSeenEventId": "<string>"
}
'import requests
url = "https://agent.getmodus.com/agent/v1/runs/{runId}/cancel"
payload = {
"organizationId": "<string>",
"reason": "<string>",
"lastSeenEventId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({organizationId: '<string>', reason: '<string>', lastSeenEventId: '<string>'})
};
fetch('https://agent.getmodus.com/agent/v1/runs/{runId}/cancel', 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://agent.getmodus.com/agent/v1/runs/{runId}/cancel",
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([
'organizationId' => '<string>',
'reason' => '<string>',
'lastSeenEventId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://agent.getmodus.com/agent/v1/runs/{runId}/cancel"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://agent.getmodus.com/agent/v1/runs/{runId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agent.getmodus.com/agent/v1/runs/{runId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"reason\": \"<string>\",\n \"lastSeenEventId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.
Path Parameters
Body
application/json
Organization the run belongs to. Omit for PAT/SDK callers — falls back to the authenticated principal's org.
Human-readable reason for the cancel, logged server-side only.
Redis Stream id of the last SSE frame the client rendered, so the persisted partial message matches what the client saw. Falls back to the server-side accumulator when absent.
Response
204 - undefined
⌘I