Skip to main content

Cancel a batch

POST/v2/batches/{id}:cancelCancel a batch

Cancels an in-progress batch

Parameters

idstringpathrequired

The batch ID.

X-Client-Namestringheader

The name of the project that is making the request.

Responses

objectCancelBatchResponse

Response to a request to cancel a batch.

Example response

{}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

objectBatchError

Error is the response for any unsuccessful event.

messagestring

A developer-facing error message.

Example response

{
  "message": "string"
}

Examples

idrequiredpath parameter

X-Client-Nameheader parameter

curl -X POST 'https://api.cohere.com/v2/batches/string:cancel'

const response = await fetch('https://api.cohere.com/v2/batches/string:cancel', { method: 'POST' });
const data = await response.json();

const response = await fetch('https://api.cohere.com/v2/batches/string:cancel', { method: 'POST' });
console.log(await response.json());

import requests

response = requests.request("POST", "https://api.cohere.com/v2/batches/string:cancel")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.cohere.com/v2/batches/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.cohere.com/v2/batches/string:cancel");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v2/batches/string:cancel"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v2/batches/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.cohere.com/v2/batches/string:cancel");
using var response = await client.SendAsync(request);

{}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}