Cancel/terminate a task - Pinecone Docs

Cancel/terminate a task

curl --request DELETE \
  --url https://{host}/api/tasks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "target": "<string>",
  "pinecone_api_key": "<string>",
  "user_token": "<string>"
}
'

import requests

url = "https://{host}/api/tasks/{id}"

payload = {
    "reason": "<string>",
    "target": "<string>",
    "pinecone_api_key": "<string>",
    "user_token": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: '<string>',
    target: '<string>',
    pinecone_api_key: '<string>',
    user_token: '<string>'
  })
};

fetch('https://{host}/api/tasks/{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://{host}/api/tasks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'target' => '<string>',
    'pinecone_api_key' => '<string>',
    'user_token' => '<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://{host}/api/tasks/{id}"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://{host}/api/tasks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/tasks/{id}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}"

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

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

DELETE

/

tasks

/

{id}

Cancel/terminate a task

curl --request DELETE \
  --url https://{host}/api/tasks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>",
  "target": "<string>",
  "pinecone_api_key": "<string>",
  "user_token": "<string>"
}
'

import requests

url = "https://{host}/api/tasks/{id}"

payload = {
    "reason": "<string>",
    "target": "<string>",
    "pinecone_api_key": "<string>",
    "user_token": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reason: '<string>',
    target: '<string>',
    pinecone_api_key: '<string>',
    user_token: '<string>'
  })
};

fetch('https://{host}/api/tasks/{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://{host}/api/tasks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => '<string>',
    'target' => '<string>',
    'pinecone_api_key' => '<string>',
    'user_token' => '<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://{host}/api/tasks/{id}"

	payload := strings.NewReader("{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://{host}/api/tasks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/tasks/{id}")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"<string>\",\n  \"target\": \"<string>\",\n  \"pinecone_api_key\": \"<string>\",\n  \"user_token\": \"<string>\"\n}"

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

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

Authorizations

Authorization

string

header

required

Session token from POST /auth/login, sent as Authorization: Bearer <token>.

Headers

X-Pinecone-Api-Version

string

default:2026-07

Date-based contract version, echoed back on the same header. Omit for the default (2026-07); send unstable for the in-development surface. An unrecognized value is rejected with 400 unsupported_api_version.

Path Parameters

id

string

required

Task id.

Body

application/json

Optional detail about the termination. A request with no body still terminates the task.

reason

string

Why the task is being terminated, recorded on the row.

target

string

Which part of the task to terminate. Defaults to the whole task.

pinecone_api_key

string

Task-token override; normally not needed.

user_token

string

Caller-token override; normally not needed.

Response

Termination enqueued (empty body)