batches

Een vertaling annuleren

Stops within one task. Work already completed is charged (credits_charged in the response, because translation that ran has a real cost); the rest of the reservation is released. The batch lands in cancelled, a terminal status of its own since 2026-09-02. It used to be reported as failed carrying error.code: "cancelled", so any count of failures silently included deliberate stops; a cancelled batch now returns no error object at all.

POST/v1/batches/{batch_id}/cancel

Request

curl --request POST \
  --url 'https://api.ai-glot.com/v1/batches/<batch_id>/cancel' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import json
import requests

url = "https://api.ai-glot.com/v1/batches/<batch_id>/cancel"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.ai-glot.com/v1/batches/<batch_id>/cancel", {
  method: "POST",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.ai-glot.com/v1/batches/<batch_id>/cancel");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://api.ai-glot.com/v1/batches/<batch_id>/cancel", bytes.NewBuffer([]byte("{}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.ai-glot.com/v1/batches/<batch_id>/cancel"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.ai-glot.com/v1/batches/<batch_id>/cancel")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "cancelled": true,
    "credits_charged": 123
  },
  "request_id": "<string>"
}

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

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

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

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

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

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

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

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

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

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

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

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

Vereist batches:write. De vertaling wordt binnen één taak gestopt, dus niet onmiddellijk: een taak die al bezig is, wordt afgemaakt in plaats van halverwege afgebroken.

Wat er in rekening wordt gebracht

Al uitgevoerd werk wordt in rekening gebracht. In het antwoord staat hoeveel in credits_charged. Het ongebruikte deel van de reservering wordt weer aan het saldo toegevoegd.

Dit is niet zozeer een terugbetalingsbeleid als wel een boekhoudkundig gegeven: voor de vertaling die al is uitgevoerd, is modelcapaciteit gebruikt. Hoe eerder je annuleert, hoe minder het kost; annuleer je bijna aan het einde, dan betaal je vrijwel het volledige bedrag.

Status van de vertaling

De batch krijgt de status cancelled. Dit is een eigen eindstatus en geen vorm van mislukking. Ook error.code krijgt de waarde "cancelled", zodat een aanroeper die alleen de fout uitleest toch weet waarom de taak is gestopt.

Dit onderscheid is belangrijk wanneer je de status opvraagt. cancelled betekent dat er niets mis is gegaan: iemand heeft het werk bewust gestopt. failed betekent dat de vertaling niet kon worden voltooid; error.code geeft aan wat er misging. Beide zijn eindstatussen, dus stop met opvragen. Alleen bij failed is opnieuw proberen of een melding versturen zinvol.

Wat de vertaling al heeft opgeleverd, kan niet worden gedownload. Een gedeeltelijk resultaat is geen vertaald bestand; zo’n resultaat aanbieden zou slechter zijn dan helemaal niets teruggeven.

Antwoord

application/json

Cancel a running translation

dataobjectrequired

Show child attributes

idstringrequired

cancelledbooleanrequired

credits_chargedintegerrequired

request_idstringrequired

Een vertaling annuleren

Wat er in rekening wordt gebracht

Status van de vertaling

Antwoord

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown