Cancel Agent Response

Requests cancellation of response {id}. Acts on durable state, so it works for background runs that outlive the client connection. Cancellation is asynchronous: a 200 acknowledges the request (status: cancelling) and the run stops shortly after - poll GET /v1/agent/{id} for its terminal status. Cancelling a run that is already terminal returns 400. Ownership is enforced server side; a cross-tenant or unknown id surfaces as 404.

POST /v1/agent/{id}/cancel

Cancel Agent Response

cURL

curl --request POST \
  --url https://api.perplexity.ai/v1/agent/{id}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.perplexity.ai/v1/agent/{id}/cancel"

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

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.perplexity.ai/v1/agent/{id}/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://api.perplexity.ai/v1/agent/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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://api.perplexity.ai/v1/agent/{id}/cancel"

	req, _ := http.NewRequest("POST", 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.post("https://api.perplexity.ai/v1/agent/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perplexity.ai/v1/agent/{id}/cancel")

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

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

response = http.request(request)
puts response.read_body

200

{
  "response_id": "<string>",
  "status": "cancelling"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response id (resp_<...>)

Response

200

application/json

The cancel request was accepted; the run is being cancelled.

response_id · string · required

The response id (resp_<...>).

status · enum<string> · required

Always cancelling - the cancel was accepted and the run stops asynchronously. An already-terminal run returns 400 instead, so no terminal status appears here.

Available options: cancelling