batches

Update a translation

Only name and archived can change — exactly what a person can already change in the web app. This exists so housekeeping can be scripted, for example archiving everything older than 90 days.

PATCH/v1/batches/{batch_id}

Request

curl --request PATCH \
  --url 'https://api.ai-glot.com/v1/batches/<batch_id>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "archived": true
}'

import json
import requests

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

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

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

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>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"archived\":true}");
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("PATCH", "https://api.ai-glot.com/v1/batches/<batch_id>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"archived\":true}")))
  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>"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"archived\":true}"))
    .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>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"archived\":true}"

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>",
    "name": "<string>",
    "file_name": "<string>",
    "status": "analyzing",
    "quality_tier": "<string>",
    "word_count": 123,
    "credit_cost": 123,
    "is_sample": true,
    "archived": true,
    "progress": {
      "phase": "<string>",
      "percent": 123.45,
      "updated_at": "<string>",
      "estimated_seconds_remaining": 123
    },
    "error": {
      "code": "<string>",
      "message": "<string>"
    },
    "created_at": "<string>",
    "completed_at": "<string>",
    "next_action": "provide_instruction",
    "plan": {
      "instruction": "<string>",
      "summary": "<string>",
      "will_translate": "<string>",
      "will_not_touch": "<string>",
      "special_rules": [
        "<string>"
      ],
      "assumptions": [
        "<string>"
      ],
      "not_included": [
        "<string>"
      ],
      "languages": [
        {
          "source": {},
          "target": {},
          "segments": {},
          "words": {}
        }
      ],
      "totals": {
        "segments": 123,
        "words": 123,
        "files": {}
      },
      "credits": {
        "standard": 123,
        "lite": 123
      },
      "preview": [
        {
          "location": {},
          "source_text": {},
          "source_lang": {},
          "target_lang": {}
        }
      ],
      "cached": true
    },
    "suggested_instructions": [
      "<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>"
}

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

Requires batches:write. Only name and archived can change. Archiving is reversible and the translated CSV itself is never modified.

Use this for housekeeping such as giving generated jobs readable names or archiving older history.

Response

application/json

Rename or archive a translation

dataobjectrequired

Show child attributes

idstringrequired

namestring | nullrequired

file_namestring | nullrequired

statusstringrequired

Where the translation is. All seven values: analyzing — the file's structure is being read, which takes seconds; poll. awaiting_instructions — the file is read, nobody has said what to translate; call plan. awaiting_approval — a plan is waiting for a yes; call approve, the only call that spends credits. translating — running; poll. completed — fetch the result. failed — the run could not finish; read error. cancelled — someone stopped it on purpose; also terminal, and not a failure. The last three are terminal: stop polling.

quality_tierstring | nullrequired

word_countinteger | nullrequired

credit_costinteger | nullrequired

is_samplebooleanrequired

archivedbooleanrequired

progressobjectrequired

errorobject | nullrequired

created_atstring | nullrequired

completed_atstring | nullrequired

next_actionstring

The call to make next, so a client never has to map status itself. provide_instruction — call plan with an instruction. review_plan — the priced plan is embedded; check plan.not_included, then approve. wait — poll again; progress.estimated_seconds_remaining says how long is left. download — fetch the result. read_error — the run is over without a result; read error (and status says whether it broke or was cancelled). Absent only on a legacy pre-2026-08-31 CSV batch, which has no plan behind it; every translation created since then answers.

planobject | null

suggested_instructionsstring[] | null

request_idstringrequired

Update a translation

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown