glossaries

Replace glossary terms

Destructive: any term not present in the request is deleted. To add or remove a few terms without touching the rest, use PATCH.

PUT/v1/glossaries/{language_pair}

Request

curl --request PUT \
  --url 'https://api.ai-glot.com/v1/glossaries/<language_pair>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "terms": {}
}'

import json
import requests

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

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

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

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.ai-glot.com/v1/glossaries/<language_pair>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"terms\":{}}");
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("PUT", "https://api.ai-glot.com/v1/glossaries/<language_pair>", bytes.NewBuffer([]byte("{\"terms\":{}}")))
  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/glossaries/<language_pair>"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"terms\":{}}"))
    .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/glossaries/<language_pair>")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"terms\":{}}"

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": {
    "glossary": {
      "language_pair": "<string>",
      "source_language": "<string>",
      "target_language": "<string>",
      "term_count": 123,
      "max_terms": 123,
      "terms": {},
      "created_at": "<string>",
      "updated_at": "<string>"
    },
    "added": 123,
    "updated": 123,
    "removed": 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>"
}

Requires glossaries:write. This is a destructive full replacement: terms omitted from the body are deleted and cannot be recovered through AI Glot.

Use Update glossary terms for ordinary incremental edits. The replacement is atomic and consumes no translation credits.

Response

application/json

Replace every term in a glossary

dataobjectrequired

Show child attributes

glossaryobjectrequired

addedintegerrequired

updatedintegerrequired

removedintegerrequired

request_idstringrequired

curl --request PUT \ --url 'https://api.ai-glot.com/v1/glossaries/<language_pair>' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "terms": {} }'

{ "data": { "glossary": { "language_pair": "<string>", "source_language": "<string>", "target_language": "<string>", "term_count": 123, "max_terms": 123, "terms": {}, "created_at": "<string>", "updated_at": "<string>" }, "added": 123, "updated": 123, "removed": 123 }, "request_id": "<string>" }

Replace glossary terms

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown