Cancel Agent Response

POST/v1/agent/{id}/cancelCancel 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.

Parameters

idstringpathrequired

Response id (`resp_<...>`)

Responses

object

response_idstringrequired

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

statusstringrequired

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

one of "cancelling"

Example response

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

object

errorobject

Error information returned when a request fails

Show child attributes

codestring

Error code

messagestringrequired

Human-readable error message

typestring

Error type category

Example response

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

object

errorobjectErrorInfo ↑

Error information returned when a request fails

Example response

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

Examples

idrequiredpath parameter

curl -X POST 'https://api.perplexity.ai/v1/agent/string/cancel'

const response = await fetch('https://api.perplexity.ai/v1/agent/string/cancel', { method: 'POST' });
const data = await response.json();

const response = await fetch('https://api.perplexity.ai/v1/agent/string/cancel', { method: 'POST' });
console.log(await response.json());

import requests

response = requests.request("POST", "https://api.perplexity.ai/v1/agent/string/cancel")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.perplexity.ai/v1/agent/string/cancel", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.perplexity.ai/v1/agent/string/cancel");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.perplexity.ai/v1/agent/string/cancel"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.perplexity.ai/v1/agent/string/cancel")
request = Net::HTTPGenericRequest.new("POST", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.perplexity.ai/v1/agent/string/cancel");
using var response = await client.SendAsync(request);

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

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

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

Search documentation

Skills

Operations

Cancel Agent Response

Parameters

Responses

Skills

Operations