curl --request POST \
--url https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel"
payload = { "reason": "<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({reason: '<string>'})
};
fetch('https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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([
'reason' => '<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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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 \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"task_id": "<string>",
"agent_id": "<string>",
"status": "queued",
"caller_id": "<string>",
"result": "<unknown>",
"error": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"deadline_at": "2023-11-07T05:31:56Z",
"truncated": true
}
}{
"success": true,
"data": {
"task_kind": "browser",
"task_id": "<string>",
"context_id": "<string>",
"agent_id": "<string>",
"status": "submitted",
"is_terminal": true,
"is_error": true,
"text": "<string>",
"cancellation_requested": true,
"artifacts": [
{
"artifactId": "<string>",
"name": "<string>",
"description": "<string>",
"parts": [
{
"text": "<string>"
}
]
}
]
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}Cancel an in-flight task.
Emits a chat_cancel envelope so the agent can abort its in-flight
turn cleanly, then closes the channel with reason=canceled.
Idempotent — re-issuing cancel on an already-canceled task is a no-op
and still returns the snapshot.
Browser exception: body must be empty or . Records durable
cancellation intent on the original task without closing its
conversation. Returns BrowserTaskEnvelope with 202 and
cancellation_requested=true while nonterminal; 200 only for a
verified terminal snapshot. Does not fabricate a canceled outcome.
curl --request POST \
--url https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"reason": "<string>"
}
'import requests
url = "https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel"
payload = { "reason": "<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({reason: '<string>'})
};
fetch('https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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([
'reason' => '<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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel"
payload := strings.NewReader("{\n \"reason\": \"<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://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/cancel")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://openapi.beeos.ai/api/v1/agents/{agentId}/tasks/{taskId}/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 \"reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"task_id": "<string>",
"agent_id": "<string>",
"status": "queued",
"caller_id": "<string>",
"result": "<unknown>",
"error": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"deadline_at": "2023-11-07T05:31:56Z",
"truncated": true
}
}{
"success": true,
"data": {
"task_kind": "browser",
"task_id": "<string>",
"context_id": "<string>",
"agent_id": "<string>",
"status": "submitted",
"is_terminal": true,
"is_error": true,
"text": "<string>",
"cancellation_requested": true,
"artifacts": [
{
"artifactId": "<string>",
"name": "<string>",
"description": "<string>",
"parts": [
{
"text": "<string>"
}
]
}
]
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}{
"success": false,
"error": {
"code": "agent_not_found",
"message": "<string>",
"type": "api_error",
"request_id": "<string>",
"param": "<string>",
"metadata": {}
}
}Authorizations
Pass a user JWT or a oag_ User API Key on the
Authorization: Bearer <token> header. Both are validated by
openapi-gateway against the Auth service.
Both credential types are user-scoped: every key (and every JWT) is bound to exactly one owner, and every route grants the caller full access to that owner's own resources. Cross-tenant access is denied by owner-ACL inside the handlers — there is no per-route scope vocabulary on this API.
Removed in v1.1.0: the legacy
agents:*/tasks:*/files:*/instances:*scope set has been dropped together with the403 insufficient_scopeerror. Existingoag_keys automatically gain full owner-level access and do not need to be re-issued. SDK calls that previously passedscopestocreateAPIKeyshould drop the argument. See the changelog at the bottom of this spec for the full migration note.
Path Parameters
128128Body
- Option 1
- Option 2
Free-form caller label propagated on the chat_cancel envelope
payload so the agent can audit-log why its turn was aborted.
Empty defaults to canceled.