Skip to main content
DELETE
/
api
/
v2
/
sessions
/
{id}
Cancel a session
curl --request DELETE \
  --url https://agp.eu.hcompany.ai/api/v2/sessions/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://agp.eu.hcompany.ai/api/v2/sessions/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://agp.eu.hcompany.ai/api/v2/sessions/{id}', 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://agp.eu.hcompany.ai/api/v2/sessions/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://agp.eu.hcompany.ai/api/v2/sessions/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("https://agp.eu.hcompany.ai/api/v2/sessions/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://agp.eu.hcompany.ai/api/v2/sessions/{id}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
Cancels a session that is still active. The agent is stopped and the session transitions to interrupted status. Cancelling a queued session dequeues it immediately, without it ever starting, and cancelling a session that already finished is a harmless no-op. Cancellation can’t be undone: use pause if you want to resume later. Returns 204 No Content on success.

Path parameters

id
string
required
The session ID to cancel.

Examples

hai sessions cancel "$SESSION_ID" --yes
curl -X DELETE https://agp.eu.hcompany.ai/api/v2/sessions/$SESSION_ID \
  -H "Authorization: Bearer $HAI_API_KEY"
from hai_agents import Client

client = Client()

client.sessions.cancel_session(session_id)
import { HaiAgentsClient } from "hai-agents";

const client = new HaiAgentsClient();

await client.sessions.cancelSession({ id: sessionId });

When to cancel vs. pause

ActionEffectCan resume?Frees quota?
Cancel (DELETE)Stops the agent, terminal stateNoYes
Pause (POST /pause)Halts the agent, preserves stateYesNo
Use cancel when:
  • The task is no longer needed
  • You want to free a concurrency slot immediately
  • The agent is stuck or producing unhelpful output
Use pause when:
  • You want to review progress before continuing
  • You need to provide input later but not right now

Errors

StatusCause
404Session not found, or you don’t have access.